SSR & Route provider support

.github/workflows/master-push.yml

@@ -29,14 +29,6 @@ jobs:
         with:
           format: DDMMHm
           utcOffset: "+03:00"
-      - name: Set up kubectl
-        uses: matootie/dokube@v1.3.4
-        with:
-          personalAccessToken: ${{ secrets.DIGITALOCEAN_TOKEN }}
-          clusterName: pankod-k8s
-          expirationTime: 1200
-      - name: Get nodes
-        run: kubectl get nodes
       - name: web docker build
         uses: docker/build-push-action@v1
         with:
@@ -45,6 +37,14 @@ jobs:
           registry: docker.pkg.github.com
           repository: pankod/refine/refine-example
           tags: sha-${{ steps.current-time.outputs.formattedTime }}
+      - name: Set up kubectl
+        uses: matootie/dokube@v1.3.4
+        with:
+          personalAccessToken: ${{ secrets.DIGITALOCEAN_TOKEN }}
+          clusterName: pankod-k8s
+          expirationTime: 1200
+      - name: Get nodes
+        run: kubectl get nodes
       - name: Deploy refine-example to k8s
         run: |
           cd examples/fineFoods
@@ -92,14 +92,6 @@ jobs:
         with:
           format: DDMMHm
           utcOffset: "+03:00"
-      - name: Set up kubectl
-        uses: matootie/dokube@v1.3.4
-        with:
-          personalAccessToken: ${{ secrets.DIGITALOCEAN_TOKEN }}
-          clusterName: pankod-k8s
-          expirationTime: 1200
-      - name: Get nodes
-        run: kubectl get nodes
       - name: web docker build
         uses: docker/build-push-action@v1
         with:
@@ -109,6 +101,14 @@ jobs:
           repository: pankod/refine/refine-documentation
           path: documentation
           tags: sha-${{ steps.current-time.outputs.formattedTime }}
+      - name: Set up kubectl
+        uses: matootie/dokube@v1.3.4
+        with:
+          personalAccessToken: ${{ secrets.DIGITALOCEAN_TOKEN }}
+          clusterName: pankod-k8s
+          expirationTime: 1200
+      - name: Get nodes
+        run: kubectl get nodes
       - name: Deploy refine-documentation to k8s
         run: |
           cd documentation

.github/workflows/pull-request-doc.yml

@@ -37,14 +37,6 @@ jobs:
         uses: actions/setup-node@v1
         with:
           node-version: ${{ matrix.node-version }}
-      - name: Set up kubectl
-        uses: matootie/dokube@v1.3.4
-        with:
-          personalAccessToken: ${{ secrets.DIGITALOCEAN_TOKEN }}
-          clusterName: pankod-k8s
-          expirationTime: 1200
-      - name: Get nodes
-        run: kubectl get nodes
       - name: documentation docker build
         uses: docker/build-push-action@v1
         with:
@@ -54,6 +46,14 @@ jobs:
           repository: pankod/refine/refine-documentation
           path: documentation
           tag_with_sha: true
+      - name: Set up kubectl
+        uses: matootie/dokube@v1.3.4
+        with:
+          personalAccessToken: ${{ secrets.DIGITALOCEAN_TOKEN }}
+          clusterName: pankod-k8s
+          expirationTime: 1200
+      - name: Get nodes
+        run: kubectl get nodes
       - name: Deploy refine-documentation to k8s
         run: |
           cd documentation
@@ -62,7 +62,7 @@ jobs:
           echo -e "\r\nappVersion: sha-${GITHUB_SHA::7}\r\n" >> ./k8s/refine-documentation/Chart.yaml &&
           cat ./k8s/refine-documentation/Chart.yaml
           helm delete ${{ env.branch }}-refine-documentation || :
-          helm upgrade ${{ env.branch }}-refine-documentation ./k8s/refine-documentation --install --atomic --values=./k8s/refine-documentation/values.yaml \
+          helm upgrade ${{ env.branch }}-refine-documentation ./k8s/refine-documentation --install --atomic --timeout 20m0s --values=./k8s/refine-documentation/values.yaml \
             --set ingress.enabled=true \
             --set ingress.annotations."kubernetes\.io/ingress\.class"=nginx \
             --set ingress.annotations."cert-manager\.io/issuer"=letsencrypt-prod \

.github/workflows/pull-request.yml

@@ -39,14 +39,6 @@ jobs:
         uses: actions/setup-node@v1
         with:
           node-version: ${{ matrix.node-version }}
-      - name: Set up kubectl
-        uses: matootie/dokube@v1.3.4
-        with:
-          personalAccessToken: ${{ secrets.DIGITALOCEAN_TOKEN }}
-          clusterName: pankod-k8s
-          expirationTime: 1200
-      - name: Get nodes
-        run: kubectl get nodes
       - name: backoffice docker build
         uses: docker/build-push-action@v1
         with:
@@ -55,6 +47,14 @@ jobs:
           registry: docker.pkg.github.com
           repository: pankod/refine/refine-example
           tag_with_sha: true
+      - name: Set up kubectl
+        uses: matootie/dokube@v1.3.4
+        with:
+          personalAccessToken: ${{ secrets.DIGITALOCEAN_TOKEN }}
+          clusterName: pankod-k8s
+          expirationTime: 1200
+      - name: Get nodes
+        run: kubectl get nodes
       - name: Deploy refine-example to k8s
         run: |
           cd examples/fineFoods

.gitignore

@@ -26,6 +26,7 @@ yarn-error.log*
 example/.eslintcache
 example/.cache
 
-examples/**/*/package-lock.json
+examples/*/package-lock.json
+!examples/fineFoods/package-lock.json
 
 .next

documentation/Dockerfile

@@ -12,5 +12,13 @@ COPY . /opt/app
 
 RUN npm run build
 
-CMD npm run serve -- --build --port 80 --host 0.0.0.0
+FROM node:14-alpine
+
+COPY --from=0 /opt/app/build /opt/app
+WORKDIR /opt/app/
+
+ENV NODE_ENV=production
+
+RUN npm install -g serve
 
+CMD serve -l 80

documentation/docusaurus.config.js

@@ -72,6 +72,11 @@ const siteConfig = {
                     label: "Guides",
                     position: "left",
                 },
+                {
+                    type: "docsVersionDropdown",
+                    position: "right",
+                    dropdownActiveClassDisabled: true,
+                },
                 {
                     href: "https://github.com/pankod/refine",
                     position: "right",

documentation/k8s/refine-documentation/templates/deployment.yaml

@@ -41,12 +41,10 @@ spec:
             httpGet:
               path: /
               port: http
-            initialDelaySeconds: 90
           readinessProbe:
             httpGet:
               path: /
               port: http
-            initialDelaySeconds: 90
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
       {{- with .Values.nodeSelector }}

documentation/versioned_docs/version-1.0.xx/api-references/components/auth/authenticated.md

@@ -0,0 +1,21 @@
+---
+id: authenticated
+title: <Authenticated>
+---
+
+`<Authenticated>` is the component form of [`useAuthenticated`][useAuthenticated]. It internally uses [`useAuthenticated`][useAuthenticated] to provide it's functionality.
+
+For an example use, see [Custom Pages Example][Custom Pages Example] and [it's explanation][Custom Pages Explanation].
+
+## API Reference
+
+### Properties
+
+| Property | Description                                                           | Type        | Default |
+| -------- | --------------------------------------------------------------------- | ----------- | ------- |
+| fallback | Content to show if user is not logged in. If undefined, routes to `/` | `ReactNode` |         |
+| loading  | Content to show while checking whether user is logged in              | `ReactNode` |         |
+
+[useAuthenticated]: /api-references/hooks/auth/useAuthenticated.md
+[Custom Pages Explanation]: /guides-and-concepts/custom-pages.md#authenticated-custom-pages
+[Custom Pages Example]: /examples/custom-pages.md

documentation/versioned_docs/version-1.0.xx/api-references/components/basic-views/create.md

@@ -0,0 +1,151 @@
+---
+id: create
+title: Create
+---
+
+import pageHeaderPropsUsage from '@site/static/img/guides-and-concepts/basic-views/create/pageHeaderPropsUsage.png'
+import actionButtonsUsage from '@site/static/img/guides-and-concepts/basic-views/create/actionButtonsUsage.png'
+
+`<Create>` provides us a layout to display the page. It does not contain any logic but adds extra functionalities like action buttons and giving titles to the page.
+
+We'll show what `<Create>` does using properties with examples.
+
+## Properties
+
+### `title`
+
+It allows adding title inside the `<Create>` component. if you don't pass title props it uses "Create" prefix and singular resource name by default. For example, for the `/posts/create` resource, it will be "Create post".
+
+```tsx twoslash
+import { Create } from "@pankod/refine";
+
+export const CreatePage: React.FC = () => {
+    return <Create title="Custom Title">...</Create>;
+};
+```
+
+### `saveButtonProps`
+
+`<Create>` component has a default button that submits the form. If you want to customize this button you can use the `saveButtonProps` property like the code below.
+
+
+[Refer to the `<SaveButton>` documentation for detailed usage. &#8594](/api-references/components/buttons/save.md)
+
+```tsx twoslash
+import { Create } from "@pankod/refine";
+
+export const CreatePage: React.FC = () => {
+    return <Create saveButtonProps={{ size: "small" }}>...</Create>;
+};
+```
+
+### `actionButtons`
+
+`<Create>` uses the Ant Design [`<Card>`](https://ant.design/components/card) component. The `action` prop of the `<Card>` component shows `<SaveButton>` and `<DeleteButton>` depending on your resource definition on the `<Resource>` components. If you want to use other things instead of these buttons, you can use the `actionButton` property like the code below.
+
+```tsx twoslash
+import { Create, Button } from "@pankod/refine";
+
+export const CreatePage: React.FC = () => {
+    return (
+        <Create
+            actionButtons={
+                <>
+                    <Button type="primary">Custom Button 1</Button>
+                    <Button size="small">Custom Button 2</Button>
+                </>
+            }
+        >
+            ...
+        </Create>
+    );
+};
+```
+
+<br/>
+<div class="img-container">
+    <div class="window">
+        <div class="control red"></div>
+        <div class="control orange"></div>
+        <div class="control green"></div>
+    </div>
+    <img src={actionButtonsUsage} alt="actionButton Usage" />
+</div>
+<br/>
+
+### `pageHeaderProps`
+
+`<Create>` uses the Ant Design `<PageHeader>` components so you can customize with the props of `pageHeaderProps`.
+
+[Refer to the `<PageHeader>` documentation for detailed usage. &#8594](https://ant.design/components/page-header/#API)
+
+```tsx twoslash
+import { Create } from "@pankod/refine";
+
+export const CreatePage: React.FC = () => {
+    return (
+        <Create
+            pageHeaderProps={{
+                onBack: () => console.log("Hello, refine"),
+                subTitle: "Subtitle",
+            }}
+        >
+            ...
+        </Create>
+    );
+};
+```
+
+<br/>
+<div class="img-container">
+    <div class="window">
+        <div class="control red"></div>
+        <div class="control orange"></div>
+        <div class="control green"></div>
+    </div>
+    <img src={pageHeaderPropsUsage} alt="pageHeaderProps Usage"/>
+</div>
+<br/>
+
+### `resource`
+
+The `<Create>` component reads the `resource` information from the route by default. This default behavior will not work on custom pages. If you want to use the `<Create>` component in a custom page, you can use the `resource` prop.
+
+[Refer to the custom pages documentation for detailed usage. &#8594](/guides-and-concepts/custom-pages.md)
+
+```tsx twoslash {2-4, 11-17}
+import { Refine, Resource, Create } from "@pankod/refine";
+import dataProvider from "@pankod/refine-simple-rest";
+
+const CustomPage = () => {
+    return <Create resource="posts">...</Create>;
+};
+
+export const App: React.FC = () => {
+    return (
+        <Refine
+            dataProvider={dataProvider("https://api.fake-rest.refine.dev/")}
+            routes={[
+                {
+                    exact: true,
+                    component: CustomPage,
+                    path: "/custom",
+                },
+            ]}
+        >
+            <Resource name="posts" />
+        </Refine>
+    );
+};
+```
+## API Reference
+
+### Properties
+
+| Property        | Description                                                                    | Type                                                              | Default                                                                            |
+| --------------- | ------------------------------------------------------------------------------ | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| saveButtonProps | Adds props for create button                                                   | `{ disabled: boolean; onClick: () => void; loading: boolean; }`   | `<SaveButton>`                                                                     |
+| title           | Adds title                                                                     | `string`                                                          | `"Edit"` prefix and singular of `resource.name`                                    |
+| actionButtons   | Passes the props for `<PageHeader>`                                            | `React.ReactNode`                                                 | `<SaveButton>` and depending on your `<Resource>` configuration (`canDelete` prop) |
+| pageHeaderProps | Passes the props for `<PageHeader>`                                            | [PageHeaderProps](https://ant.design/components/page-header/#API) | { ghost: false, [title](#title), extra: `<ListButton>` and `<RefreshButton>` }     |
+| resource        | [`Resource`](/api-references/components/resource.md) for API data interactions | `string`                                                          | Resource name that it reads from the URL.                                          |