@takeshape/schema 7.194.0

package/examples/v3_6_0/user-schema-no-required.json

@@ -0,0 +1,185 @@
+{
+  "$schema": "https://schema.takeshape.io/project-schema#",
+  "version": 1,
+  "apiVersion": "1",
+  "author": "<userId>",
+  "projectId": "project-id",
+  "locales": [
+    "en-us"
+  ],
+  "defaultLocale": "en-us",
+  "workflows": {},
+  "queries": {
+    "getUser": {
+      "shape": "User",
+      "resolver": {
+        "name": "takeshape:get",
+        "service": "takeshape:local",
+        "options": {
+          "model": "User"
+        }
+      },
+      "description": "Get a User by ID",
+      "args": "TSGetArgs<User>"
+    },
+    "getUserList": {
+      "shape": "PaginatedList<User>",
+      "resolver": {
+        "name": "takeshape:list",
+        "service": "takeshape:local",
+        "options": {
+          "model": "User"
+        }
+      },
+      "description": "Returns a list User in natural order.",
+      "args": "TSListArgs<User>"
+    }
+  },
+  "mutations": {
+    "updateUser": {
+      "shape": "UpdateResult<User>",
+      "resolver": {
+        "name": "takeshape:update",
+        "service": "takeshape:local",
+        "options": {
+          "model": "User"
+        }
+      },
+      "description": "Update User",
+      "args": "UpdateArgs<User>"
+    },
+    "createUser": {
+      "shape": "CreateResult<User>",
+      "resolver": {
+        "name": "takeshape:create",
+        "service": "takeshape:local",
+        "options": {
+          "model": "User"
+        }
+      },
+      "description": "Create User",
+      "args": "CreateArgs<User>"
+    },
+    "duplicateUser": {
+      "shape": "DuplicateResult<User>",
+      "resolver": {
+        "name": "takeshape:duplicate",
+        "service": "takeshape:local",
+        "options": {
+          "model": "User"
+        }
+      },
+      "description": "Duplicate User",
+      "args": "DuplicateArgs<User>"
+    },
+    "deleteUser": {
+      "shape": "DeleteResult<User>",
+      "resolver": {
+        "name": "takeshape:delete",
+        "service": "takeshape:local",
+        "options": {
+          "model": "User"
+        }
+      },
+      "description": "Delete User",
+      "args": "DeleteArgs<User>"
+    }
+  },
+  "schemaVersion": "3.6.0",
+  "created": "2016-06-21T15:16:19.051Z",
+  "updated": "2016-06-21T15:16:19.051Z",
+  "shapes": {
+    "User": {
+      "id": "<userContentTypeId>",
+      "name": "User",
+      "title": "User",
+      "model": {
+        "type": "multiple"
+      },
+      "schema": {
+        "type": "object",
+        "properties": {
+          "firstName": {
+            "type": "string",
+            "@mapping": "takeshape:local:User.firstNameId"
+          },
+          "lastName": {
+            "type": "string",
+            "@mapping": "takeshape:local:User.lastNameId"
+          },
+          "username": {
+            "type": "string",
+            "default": "dude",
+            "maxLength": 16,
+            "minLength": 3,
+            "pattern": "^[a-z0-9_-]+$",
+            "@mapping": "takeshape:local:User.usernameId"
+          },
+          "email": {
+            "type": "string",
+            "format": "email",
+            "@mapping": "takeshape:local:User.emailId"
+          },
+          "password": {
+            "type": "string",
+            "@sensitive": true,
+            "maxLength": 16,
+            "minLength": 3,
+            "@mapping": "takeshape:local:User.passwordId"
+          },
+          "roles": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "@mapping": "takeshape:local:User.rolesId"
+          },
+          "locations": {
+            "type": "array",
+            "items": {
+              "$ref": "#/shapes/UserLocations/schema"
+            },
+            "@mapping": "takeshape:local:User.locationsId"
+          }
+        },
+        "required": []
+      }
+    },
+    "UserLocations": {
+      "id": "locationsId",
+      "name": "UserLocations",
+      "title": "User Locations",
+      "schema": {
+        "type": "object",
+        "properties": {
+          "lat": {
+            "type": "number",
+            "default": 40.694598,
+            "@mapping": "takeshape:local:UserLocations.latId"
+          },
+          "lon": {
+            "type": "number",
+            "default": 73.983119,
+            "@mapping": "takeshape:local:UserLocations.lonId"
+          }
+        }
+      }
+    }
+  },
+  "forms": {
+    "User": {
+      "default": {
+        "order": [
+          "firstName",
+          "lastName",
+          "username",
+          "email",
+          "password",
+          "roles",
+          "locations"
+        ]
+      }
+    }
+  },
+  "dataKey": "supersecret"
+}

package/examples/v3_6_0/user-schema-with-defaults.json

@@ -0,0 +1,210 @@
+{
+  "$schema": "https://schema.takeshape.io/project-schema#",
+  "version": 1,
+  "apiVersion": "1",
+  "author": "<userId>",
+  "projectId": "project-id",
+  "locales": [
+    "en-us"
+  ],
+  "defaultLocale": "en-us",
+  "workflows": {},
+  "queries": {
+    "getUser": {
+      "shape": "User",
+      "resolver": {
+        "name": "takeshape:get",
+        "service": "takeshape:local",
+        "options": {
+          "model": "User"
+        }
+      },
+      "description": "Get a User by ID",
+      "args": "TSGetArgs<User>"
+    },
+    "getUserList": {
+      "shape": "PaginatedList<User>",
+      "resolver": {
+        "name": "takeshape:list",
+        "service": "takeshape:local",
+        "options": {
+          "model": "User"
+        }
+      },
+      "description": "Returns a list User in natural order.",
+      "args": "TSListArgs<User>"
+    }
+  },
+  "mutations": {
+    "updateUser": {
+      "shape": "UpdateResult<User>",
+      "resolver": {
+        "name": "takeshape:update",
+        "service": "takeshape:local",
+        "options": {
+          "model": "User"
+        }
+      },
+      "description": "Update User",
+      "args": "UpdateArgs<User>"
+    },
+    "createUser": {
+      "shape": "CreateResult<User>",
+      "resolver": {
+        "name": "takeshape:create",
+        "service": "takeshape:local",
+        "options": {
+          "model": "User"
+        }
+      },
+      "description": "Create User",
+      "args": "CreateArgs<User>"
+    },
+    "duplicateUser": {
+      "shape": "DuplicateResult<User>",
+      "resolver": {
+        "name": "takeshape:duplicate",
+        "service": "takeshape:local",
+        "options": {
+          "model": "User"
+        }
+      },
+      "description": "Duplicate User",
+      "args": "DuplicateArgs<User>"
+    },
+    "deleteUser": {
+      "shape": "DeleteResult<User>",
+      "resolver": {
+        "name": "takeshape:delete",
+        "service": "takeshape:local",
+        "options": {
+          "model": "User"
+        }
+      },
+      "description": "Delete User",
+      "args": "DeleteArgs<User>"
+    }
+  },
+  "schemaVersion": "3.6.0",
+  "created": "2016-06-21T15:16:19.051Z",
+  "updated": "2016-06-21T15:16:19.051Z",
+  "shapes": {
+    "User": {
+      "id": "<userContentTypeId>",
+      "name": "User",
+      "title": "User",
+      "model": {
+        "type": "multiple"
+      },
+      "schema": {
+        "type": "object",
+        "properties": {
+          "firstName": {
+            "type": "string",
+            "@l10n": true,
+            "@mapping": "takeshape:local:User.firstNameId"
+          },
+          "lastName": {
+            "type": "string",
+            "@l10n": true,
+            "@mapping": "takeshape:local:User.lastNameId"
+          },
+          "age": {
+            "type": "number",
+            "@mapping": "takeshape:local:User.ageId"
+          },
+          "username": {
+            "type": "string",
+            "default": "dude",
+            "maxLength": 16,
+            "minLength": 3,
+            "pattern": "^[a-z0-9_-]+$",
+            "@mapping": "takeshape:local:User.usernameId"
+          },
+          "email": {
+            "type": "string",
+            "@l10n": false,
+            "format": "email",
+            "@mapping": "takeshape:local:User.emailId"
+          },
+          "password": {
+            "type": "string",
+            "@sensitive": true,
+            "maxLength": 16,
+            "minLength": 3,
+            "@mapping": "takeshape:local:User.passwordId"
+          },
+          "roles": {
+            "type": "array",
+            "@l10n": true,
+            "items": {
+              "type": "string"
+            },
+            "@mapping": "takeshape:local:User.rolesId"
+          },
+          "locations": {
+            "type": "array",
+            "@l10n": true,
+            "@syncLocaleStructure": true,
+            "items": {
+              "$ref": "#/shapes/UserLocations/schema"
+            },
+            "@mapping": "takeshape:local:User.locationsId"
+          }
+        },
+        "required": [
+          "firstName",
+          "lastName",
+          "username",
+          "email",
+          "password",
+          "roles",
+          "locations"
+        ]
+      }
+    },
+    "UserLocations": {
+      "id": "locationsId",
+      "name": "UserLocations",
+      "title": "User Locations",
+      "schema": {
+        "type": "object",
+        "properties": {
+          "lat": {
+            "type": "string",
+            "default": "40.694598",
+            "@l10n": true,
+            "@mapping": "takeshape:local:UserLocations.latId"
+          },
+          "lon": {
+            "type": "string",
+            "default": "73.983119",
+            "@l10n": true,
+            "@mapping": "takeshape:local:UserLocations.lonId"
+          }
+        },
+        "required": [
+          "lat",
+          "lon"
+        ]
+      }
+    }
+  },
+  "forms": {
+    "User": {
+      "default": {
+        "order": [
+          "firstName",
+          "lastName",
+          "age",
+          "username",
+          "email",
+          "password",
+          "roles",
+          "locations"
+        ]
+      }
+    }
+  },
+  "dataKey": "supersecret"
+}

package/lib/api-version.d.ts

@@ -0,0 +1,6 @@
+import SemVer from 'semver/classes/semver';
+export declare type VersionCompareFn = (apiVersion: string | SemVer, featureVersion: string | SemVer) => boolean;
+export declare const createVersionPredicate: (featureVersion: string | SemVer, comparison: VersionCompareFn) => (apiVersion: string | SemVer) => boolean;
+export declare const workflowsEnabled: (apiVersion: string | SemVer) => boolean;
+export declare const whereClauseEnabled: (apiVersion: string | SemVer) => boolean;
+//# sourceMappingURL=api-version.d.ts.map

package/lib/api-version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-version.d.ts","sourceRoot":"","sources":["../../src/api-version.ts"],"names":[],"mappings":"AAEA,OAAO,MAAM,MAAM,uBAAuB,CAAC;AAE3C,oBAAY,gBAAgB,GAAG,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,MAAM,KAAK,OAAO,CAAC;AAEzG,eAAO,MAAM,sBAAsB,mBACjB,MAAM,GAAG,MAAM,cACnB,gBAAgB,kBACb,MAAM,GAAG,MAAM,KAAK,OAcpC,CAAC;AAEF,eAAO,MAAM,gBAAgB,eAhBZ,MAAM,GAAG,MAAM,KAAK,OAgB+B,CAAC;AAErE,eAAO,MAAM,kBAAkB,eAlBd,MAAM,GAAG,MAAM,KAAK,OAkBiC,CAAC"}

package/lib/api-version.js

@@ -0,0 +1,36 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.whereClauseEnabled = exports.workflowsEnabled = exports.createVersionPredicate = void 0;
+
+var _gte = _interopRequireDefault(require("semver/functions/gte"));
+
+var _coerce = _interopRequireDefault(require("semver/functions/coerce"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const createVersionPredicate = (featureVersion, comparison) => {
+  const coercedFeatureVersion = (0, _coerce.default)(featureVersion);
+
+  if (!coercedFeatureVersion) {
+    throw new Error(`Could not create predicate version "${featureVersion}" is not valid`);
+  }
+
+  return apiVersion => {
+    const coercedApiVersion = (0, _coerce.default)(apiVersion);
+
+    if (!coercedApiVersion) {
+      throw new Error(`Version "${apiVersion}" is not valid and could not be coerced`);
+    }
+
+    return comparison(coercedApiVersion, coercedFeatureVersion);
+  };
+};
+
+exports.createVersionPredicate = createVersionPredicate;
+const workflowsEnabled = createVersionPredicate('2.0.0', _gte.default);
+exports.workflowsEnabled = workflowsEnabled;
+const whereClauseEnabled = createVersionPredicate('2.0.0', _gte.default);
+exports.whereClauseEnabled = whereClauseEnabled;

package/lib/auth-schemas.d.ts

@@ -0,0 +1,105 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * A role import document is an array of role
+ *
+ * This interface was referenced by `AuthSchemas`'s JSON-Schema
+ * via the `definition` "RoleImport".
+ */
+export declare type RoleImport = RoleInput[];
+export interface AuthSchemas {
+    [k: string]: any;
+}
+/**
+ * This interface was referenced by `AuthSchemas`'s JSON-Schema
+ * via the `definition` "Condition".
+ */
+export interface Condition {
+}
+/**
+ * This interface was referenced by `AuthSchemas`'s JSON-Schema
+ * via the `definition` "Statement".
+ */
+export interface Statement {
+    Effect?: 'Allow' | 'Deny';
+    Sid?: string;
+    Action?: string[];
+    NotAction?: string[];
+    Resource?: string[];
+    NotResource?: string[];
+    Principal?: {
+        AWS?: string[];
+        Service?: string[];
+    };
+    Condition?: Condition;
+}
+/**
+ * This interface was referenced by `AuthSchemas`'s JSON-Schema
+ * via the `definition` "AccessPolicyDocument".
+ */
+export interface AccessPolicyDocument {
+    Version: string;
+    Statement: Statement[];
+}
+/**
+ * This interface was referenced by `AuthSchemas`'s JSON-Schema
+ * via the `definition` "ApiKey".
+ */
+export interface ApiKey {
+    projectId: string;
+    name: string;
+    role?: string;
+    permissions?: AccessPolicyDocument;
+    lastUsed?: string;
+    apiKey?: string;
+    id: string;
+    delinquent?: boolean;
+    apiRateLimit?: number;
+    deactivated?: number;
+}
+/**
+ * This interface was referenced by `AuthSchemas`'s JSON-Schema
+ * via the `definition` "UserPermission".
+ */
+export interface UserPermission {
+    projectId: string;
+    userId: string;
+    role: string;
+    permissions?: AccessPolicyDocument;
+    created?: number;
+    updated?: number;
+    deactivated?: number;
+    delinquent?: boolean;
+}
+/**
+ * This interface was referenced by `AuthSchemas`'s JSON-Schema
+ * via the `definition` "Role".
+ */
+export interface Role {
+    projectId: string;
+    name: string;
+    conditions?: Condition;
+    permissions: AccessPolicyDocument;
+    builtIn?: boolean;
+    created?: number;
+    updated?: number;
+}
+/**
+ * Input type for role creation and updates.
+ *
+ * This interface was referenced by `AuthSchemas`'s JSON-Schema
+ * via the `definition` "RoleInput".
+ */
+export interface RoleInput {
+    projectId?: string;
+    name: string;
+    conditions?: Condition;
+    permissions: AccessPolicyDocument;
+    builtIn?: boolean;
+    created?: number;
+    updated?: number;
+}
+//# sourceMappingURL=auth-schemas.d.ts.map

package/lib/auth-schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth-schemas.d.ts","sourceRoot":"","sources":["../../src/auth-schemas.ts"],"names":[],"mappings":"AACA;;;;GAIG;AAEH;;;;;GAKG;AACH,oBAAY,UAAU,GAAG,SAAS,EAAE,CAAC;AAErC,MAAM,WAAW,WAAW;IAC1B,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;CAClB;AACD;;;GAGG;AACH,MAAM,WAAW,SAAS;CAAG;AAC7B;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAC1B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,SAAS,CAAC,EAAE;QACV,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;KACpB,CAAC;IACF,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AACD;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,SAAS,EAAE,CAAC;CACxB;AACD;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,oBAAoB,CAAC;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AACD;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,oBAAoB,CAAC;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AACD;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,SAAS,CAAC;IACvB,WAAW,EAAE,oBAAoB,CAAC;IAClC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AACD;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,SAAS,CAAC;IACvB,WAAW,EAAE,oBAAoB,CAAC;IAClC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/lib/auth-schemas.js

@@ -0,0 +1 @@
+"use strict";

package/lib/builtin-schema.d.ts

@@ -0,0 +1,8 @@
+import { FormMap, ShapeMap } from './project-schema';
+import { Content } from './types';
+export declare function isAsset(content: Content): boolean;
+export declare function getAssetS3Path(content: Content): string | undefined;
+export declare function setAssetS3Path(content: Content, path: string): void;
+export declare const builtInShapes: ShapeMap;
+export declare const builtInForms: FormMap;
+//# sourceMappingURL=builtin-schema.d.ts.map

package/lib/builtin-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"builtin-schema.d.ts","sourceRoot":"","sources":["../../src/builtin-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAE,QAAQ,EAAC,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAC,OAAO,EAAC,MAAM,SAAS,CAAC;AAEhC,wBAAgB,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAEjD;AAID,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAEnE;AAED,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAEnE;AAED,eAAO,MAAM,aAAa,EAAE,QAyS3B,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,OA+P1B,CAAC"}