@takeshape/schema 7.194.0

package/es/versions.js

@@ -0,0 +1,4 @@
+export const CURRENT_SCHEMA_VERSION = '3.6.0';
+export const LEGACY_SCHEMA_VERSION = '1.0.0';
+export const CURRENT_API_VERSION = '2';
+export const LEGACY_API_VERSION = '1';

package/es/workflows.js

@@ -0,0 +1,69 @@
+import { getShapeById } from './schema-util';
+export const defaultWorkflow = {
+  name: 'default',
+  title: 'Default',
+  steps: [{
+    name: 'disabled',
+    title: 'Disabled',
+    key: 'r1uCfi4ZL',
+    color: '#bdbdbd',
+    live: false
+  }, {
+    name: 'enabled',
+    title: 'Enabled',
+    key: 'rkhRGs4WL',
+    color: '#5cd79b',
+    live: true
+  }]
+};
+export function getWorkflow(projectSchema, shapeId) {
+  var _getShapeById;
+
+  const workflow = (_getShapeById = getShapeById(projectSchema, shapeId)) === null || _getShapeById === void 0 ? void 0 : _getShapeById.workflow;
+  return projectSchema.workflows[workflow !== null && workflow !== void 0 ? workflow : 'default'];
+}
+export function statusFallback(workflow, enabled) {
+  var _workflow$steps$find;
+
+  return (_workflow$steps$find = workflow.steps.find(workflow => workflow.live === enabled)) !== null && _workflow$steps$find !== void 0 ? _workflow$steps$find : workflow.steps[0];
+}
+export function findWorkflowStep(workflow, keyOrName) {
+  const index = workflow.steps.findIndex(workflow => workflow.key === keyOrName || workflow.name === keyOrName);
+  return index === -1 ? undefined : {
+    index,
+    step: workflow.steps[index]
+  };
+}
+export function getStatusField(workflows, shape) {
+  const workflow = shape.workflow && workflows[shape.workflow] || defaultWorkflow;
+  return {
+    type: 'string',
+    title: 'Status',
+    '@workflow': workflow.name
+  };
+}
+export function getStepRange(steps, index, op) {
+  if (op === 'eq' || op === 'in') {
+    return [steps[index]];
+  }
+
+  const offset = op === 'lte' || op === 'gte' ? 0 : 1;
+  const start = op === 'gt' || op === 'gte' ? index + offset : 0;
+  const end = op === 'lt' || op === 'lte' ? index + 1 - offset : steps.length;
+  return steps.slice(start, end);
+}
+export function getWorkflowStepKeys(workflow, stepKey, op) {
+  const context = findWorkflowStep(workflow, stepKey);
+
+  if (!context) {
+    throw new Error(`Cannot find step "${stepKey}" in workflow "${workflow.title}"`);
+  }
+
+  const {
+    index
+  } = context;
+  return getStepRange(workflow.steps, index, op).map(step => step.key);
+}
+export function getLiveStepKeys(workflow) {
+  return workflow.steps.filter(step => step.live).map(step => step.key);
+}

package/examples/.pnpm-debug.log

@@ -0,0 +1,20 @@
+{
+  "0 debug pnpm:scope": {
+    "selected": 1,
+    "workspacePrefix": "/Users/als/code/takeshape"
+  },
+  "1 error pnpm": {
+    "errno": 2,
+    "code": "ELIFECYCLE",
+    "pkgid": "@takeshape/schema@7.185.1",
+    "stage": "typecheck",
+    "script": "tsc --noEmit",
+    "pkgname": "@takeshape/schema",
+    "err": {
+      "name": "Error",
+      "message": "@takeshape/schema@7.185.1 typecheck: `tsc --noEmit`\nExit status 2",
+      "code": "ELIFECYCLE",
+      "stack": "Error: @takeshape/schema@7.185.1 typecheck: `tsc --noEmit`\nExit status 2\n    at EventEmitter.<anonymous> (/Users/als/.nvm/versions/node/v14.16.0/pnpm-global/4/node_modules/.pnpm/pnpm@6.11.5/node_modules/pnpm/dist/pnpm.cjs:104748:20)\n    at EventEmitter.emit (events.js:315:20)\n    at ChildProcess.<anonymous> (/Users/als/.nvm/versions/node/v14.16.0/pnpm-global/4/node_modules/.pnpm/pnpm@6.11.5/node_modules/pnpm/dist/pnpm.cjs:93054:18)\n    at ChildProcess.emit (events.js:315:20)\n    at maybeClose (internal/child_process.js:1048:16)\n    at Process.ChildProcess._handle.onexit (internal/child_process.js:288:5)"
+    }
+  }
+}

package/examples/v1_0_0/beer-schema.json

@@ -0,0 +1,125 @@
+{
+  "$schema": "https://schema.takeshape.io/project-schema#",
+  "projectId": "project-id",
+  "version": 1,
+  "apiVersion": "1",
+  "author": "<userId>",
+  "created": 1466522179051,
+  "updated": 1466522179051,
+  "locales": ["en"],
+  "defaultLocale": "en",
+  "workflows": {},
+  "contentTypes": {
+    "<beer-content-type-id>": {
+      "single": false,
+      "name": "beer",
+      "title": "Beer",
+      "schema": {
+        "type": "object",
+        "properties": {
+          "_enabled": {
+            "title": "Enabled",
+            "type": "boolean"
+          },
+          "name": {
+            "description": "Very impressive very important",
+            "title": "Name",
+            "type": "string",
+            "key": "rk-Vsa4Gl",
+            "minLength": 1
+          },
+          "about": {
+            "type": "object",
+            "draftjs": true,
+            "title": "About",
+            "key": "S1p2CYznZ"
+          },
+          "_updatedAt": {
+            "title": "Updated Date",
+            "type": "string",
+            "format": "date-time"
+          },
+          "_contentTypeId": {
+            "title": "Content Type Id",
+            "type": "string"
+          },
+          "dropdown": {
+            "oneOf": [
+              {
+                "title": "Option 1",
+                "enum": [
+                  "option1"
+                ]
+              },
+              {
+                "title": "Option 2",
+                "enum": [
+                  "option2"
+                ]
+              }
+            ],
+            "type": "string",
+            "title": "Dropdown",
+            "key": "SylJmaIVz"
+          },
+          "_enabledAt": {
+            "title": "Enabled Date",
+            "type": "string",
+            "format": "date-time"
+          },
+          "_version": {
+            "title": "Version",
+            "type": "integer"
+          },
+          "_id": {
+            "title": "Id",
+            "type": "string"
+          },
+          "_createdAt": {
+            "title": "Created Date",
+            "type": "string",
+            "format": "date-time"
+          },
+          "publishDate": {
+            "format": "date-time",
+            "type": "string",
+            "title": "Publish Date",
+            "key": "Hy8mZOdZf"
+          },
+          "_contentTypeName": {
+            "title": "Content Type Name",
+            "type": "string"
+          }
+        },
+        "required": [
+          "name",
+          "image"
+        ]
+      },
+      "forms": {
+        "default": {
+          "properties": {
+            "name": {
+              "widget": "singleLineText"
+            },
+            "publishDate": {
+              "widget": "datetime"
+            },
+            "about": {
+              "widget": "wysiwygText"
+            },
+            "dropdown": {
+              "widget": "dropdown"
+            }
+          },
+          "order": [
+            "name",
+            "publishDate",
+            "about",
+            "dropdown"
+          ]
+        }
+      }
+    }
+  }
+}

package/examples/v1_0_0/blog-schema.json

@@ -0,0 +1,192 @@
+{
+  "$schema": "https://schema.takeshape.io/project-schema#",
+  "projectId": "project-id",
+  "defaultLocale": "en",
+  "locales": ["en", "es"],
+  "version": 1,
+  "apiVersion": "2",
+  "author": "<userId>",
+  "created": 1466522179051,
+  "updated": 1466522179051,
+  "workflows": {},
+  "contentTypes": {
+    "<homepageContentTypeId>": {
+      "name": "homepage",
+      "title": "Home Page",
+      "description": "The homepage",
+      "single": true,
+      "schema": {
+        "type": "object",
+        "properties": {
+          "headline": {
+            "key": "headlineId",
+            "type": "string",
+            "minLength": 1,
+            "l10n": true
+          },
+          "hero": {
+            "mutable": true,
+            "key": "heroId",
+            "type": "object",
+            "properties": {
+              "image": {
+                "title": "Image",
+                "l10n": true,
+                "relationship": {
+                  "contentTypeIds": ["ASSET"]
+                },
+                "type": "object",
+                "key": "imageId",
+                "properties": {
+                  "contentTypeId": {
+                    "type": "string",
+                    "enum": ["ASSET"]
+                  },
+                  "id": {
+                    "type": "string"
+                  }
+                },
+                "required": ["contentTypeId", "id"]
+              },
+              "featuredPosts": {
+                "key": "featuredPostsId",
+                "l10n": true,
+                "relationship": {
+                  "type": "multiple",
+                  "relatedName": "heroFeaturedPosts",
+                  "contentTypeIds": ["<postContentTypeId>"]
+                },
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "contentTypeId": {
+                      "type": "string",
+                      "enum": ["<postContentTypeId>"]
+                    },
+                    "id": {
+                      "type": "string"
+                    }
+                  },
+                  "required": ["contentTypeId", "id"]
+                }
+              }
+            }
+          }
+        },
+        "required": ["headline"]
+      },
+      "forms": {
+        "default": {
+          "order": ["headline", "hero"]
+        }
+      }
+    },
+    "<postContentTypeId>": {
+      "name": "post",
+      "title": "Post",
+      "description": "A Post model",
+      "schema": {
+        "type": "object",
+        "properties": {
+          "title": {
+            "key": "titleId",
+            "type": "string",
+            "l10n": true
+          },
+          "body": {
+            "key": "bodyId",
+            "type": "string",
+            "l10n": true,
+            "pattern": "\\w"
+          },
+          "rating": {
+            "key": "ratingId",
+            "type": "integer"
+          },
+          "otherStuff": {
+            "mutable": true,
+            "key": "otherStuffId",
+            "type": "object",
+            "properties": {
+              "comments": {
+                "l10n": true,
+                "syncLocaleStructure": true,
+                "key": "commentsId",
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "text": {
+                      "key": "textId",
+                      "type": "string"
+                    },
+                    "authors": {
+                      "type": "array",
+                      "key": "authorsId",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "name": {
+                            "type": "string",
+                            "key": "nameId"
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "tags": {
+            "key": "tagsId",
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "contentTypeId": {
+                  "enum": ["<tagContentTypeId>"],
+                  "type": "string"
+                },
+                "id": {"type": "string"}
+              },
+              "required": ["contentTypeId", "id"]
+            },
+            "relationship": {
+              "contentTypeIds": ["<tagContentTypeId>"],
+              "type": "multiple",
+              "relatedName": "firstTags"
+            }
+          }
+        },
+        "required": ["title"]
+      },
+      "forms": {
+        "default": {
+          "order": ["title", "body", "rating", "otherStuff", "tags"]
+        }
+      }
+    },
+    "<tagContentTypeId>": {
+      "name": "tag",
+      "title": "Tag",
+      "description": "A Tag model",
+      "schema": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "key": "nameId",
+            "type": "string"
+          }
+        },
+        "required": ["name"]
+      },
+      "forms": {
+        "default": {
+          "order": ["name"]
+        }
+      }
+    }
+  }
+}

package/examples/v1_0_0/brewery-schema.json

@@ -0,0 +1,232 @@
+{
+  "$schema": "http://takeshape.io/schemas/project-schema#",
+  "version": 1,
+  "author": "<userId>",
+  "apiVersion": "2",
+  "projectId": "project-id",
+  "defaultLocale": "en-us",
+  "locales":  ["en-us"],
+  "workflows": {},
+  "created": 1466522179051,
+  "updated": 1466522179051,
+  "contentTypes": {
+    "BREWERY": {
+      "name": "brewery",
+      "single": false,
+      "schema": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "pattern": "^[\\S\\s]*?$",
+            "description": "",
+            "title": "Name",
+            "type": "string",
+            "key": "SkngG4Tkl",
+            "minLength": 0
+          },
+          "addresses": {
+            "description": "",
+            "type": "array",
+            "title": "Addresses",
+            "items": {
+              "type": "object",
+              "properties": {
+                "image": {
+                  "description": "",
+                  "title": "Image",
+                  "key": "HkIsDL6ye",
+                  "type": "object",
+                  "properties": {
+                    "contentTypeId": {
+                      "type": "string",
+                      "enum": ["ASSET"]
+                    },
+                    "id": {
+                      "type": "string"
+                    }
+                  },
+                  "required": ["contentTypeId", "id"],
+                  "relationship": {
+                    "contentTypeIds": ["ASSET"],
+                    "type": "single"
+                  }
+                },
+                "zipCode": {
+                  "pattern": "^[\\S\\s]*?$",
+                  "description": "",
+                  "title": "Zip Code",
+                  "type": "string",
+                  "key": "ryyeGNp1g",
+                  "minLength": 0
+                },
+                "state": {
+                  "pattern": "^[\\S\\s]*?$",
+                  "description": "",
+                  "title": "State",
+                  "type": "string",
+                  "key": "SJuRbE6yx",
+                  "minLength": 0
+                },
+                "city": {
+                  "pattern": "^[\\S\\s]*?$",
+                  "description": "",
+                  "title": "City",
+                  "type": "string",
+                  "key": "S1ICWNa1e",
+                  "minLength": 0
+                },
+                "street": {
+                  "pattern": "^[\\S\\s]*?$",
+                  "description": "",
+                  "title": "Street",
+                  "type": "string",
+                  "key": "Hy40-N61l",
+                  "minLength": 0
+                }
+              }
+            },
+            "key": "Hk56WNpke"
+          },
+          "_id": {
+            "title": "Id",
+            "type": "string"
+          },
+          "_contentTypeId": {
+            "title": "Content Type Id",
+            "type": "string"
+          },
+          "_version": {
+            "title": "Version",
+            "type": "integer"
+          },
+          "_createdAt": {
+            "title": "Created Date",
+            "type": "string",
+            "format": "date-time"
+          },
+          "_updatedAt": {
+            "title": "Updated Date",
+            "type": "string",
+            "format": "date-time"
+          },
+          "_enabled": {
+            "title": "Enabled",
+            "type": "boolean"
+          },
+          "_enabledAt": {
+            "title": "Enabled Date",
+            "type": "string",
+            "format": "date-time"
+          }
+        },
+        "required": ["name"]
+      },
+      "title": "Brewery",
+      "forms": {
+        "default": {
+          "properties": {
+            "name": {
+              "widget": "singleLineText"
+            },
+            "addresses": {
+              "properties": {
+                "image": {
+                  "widget": "image"
+                },
+                "zipCode": {
+                  "widget": "singleLineText"
+                },
+                "state": {
+                  "widget": "singleLineText"
+                },
+                "city": {
+                  "widget": "singleLineText"
+                },
+                "street": {
+                  "widget": "singleLineText"
+                }
+              },
+              "widget": "repeater",
+              "order": ["image", "street", "city", "state", "zipCode"]
+            }
+          },
+          "order": ["name", "addresses"]
+        }
+      }
+    },
+    "ASSET": {
+      "name": "asset",
+      "title": "Asset",
+      "description": "The built-in TakeShape asset model",
+      "schema": {
+        "type": "object",
+        "properties": {
+          "_enabled": {
+            "title": "Enabled",
+            "type": "boolean"
+          },
+          "filename": {
+            "title": "Filename",
+            "key": "H1oYQOM9",
+            "type": "string"
+          },
+          "mimeType": {
+            "title": "MIME type",
+            "key": "SyCYX_Gq",
+            "type": "string"
+          },
+          "_updatedAt": {
+            "title": "Updated Date",
+            "type": "string",
+            "format": "date-time"
+          },
+          "uploadStatus": {
+            "title": "Upload status",
+            "key": "ByeAYXdG9",
+            "type": "string",
+            "enum": ["PENDING", "COMPLETE"]
+          },
+          "_enabledAt": {
+            "title": "Enabled Date",
+            "type": "string",
+            "format": "date-time"
+          },
+          "title": {
+            "title": "Title",
+            "key": "By5tQOMc",
+            "type": "string"
+          },
+          "_version": {
+            "title": "Version",
+            "type": "integer"
+          },
+          "_id": {
+            "title": "Id",
+            "type": "string"
+          },
+          "_contentTypeId": {
+            "title": "Content Type Id",
+            "type": "string"
+          },
+          "_createdAt": {
+            "title": "Created Date",
+            "type": "string",
+            "format": "date-time"
+          },
+          "path": {
+            "title": "s3 key",
+            "key": "Hk6FQuz5",
+            "type": "string"
+          }
+        },
+        "required": ["filename", "path"]
+      },
+      "forms": {
+        "default": {
+          "order": ["title"]
+        }
+      },
+      "hidden": true
+    }
+  }
+}