@takeshape/schema 7.194.0

package/README.md

@@ -0,0 +1,5 @@
+# Schema
+
+## Summary
+
+The heart of TakeShape, schema defines the meta-schema for project schemas and utilities for manipulating them.

package/es/api-version.js

@@ -0,0 +1,21 @@
+import gte from 'semver/functions/gte';
+import coerce from 'semver/functions/coerce';
+export const createVersionPredicate = (featureVersion, comparison) => {
+  const coercedFeatureVersion = coerce(featureVersion);
+
+  if (!coercedFeatureVersion) {
+    throw new Error(`Could not create predicate version "${featureVersion}" is not valid`);
+  }
+
+  return apiVersion => {
+    const coercedApiVersion = coerce(apiVersion);
+
+    if (!coercedApiVersion) {
+      throw new Error(`Version "${apiVersion}" is not valid and could not be coerced`);
+    }
+
+    return comparison(coercedApiVersion, coercedFeatureVersion);
+  };
+};
+export const workflowsEnabled = createVersionPredicate('2.0.0', gte);
+export const whereClauseEnabled = createVersionPredicate('2.0.0', gte);

package/es/builtin-schema.js

@@ -0,0 +1,590 @@
+export function isAsset(content) {
+  return content._contentTypeId === 'ASSET' || content._shapeId === 'ASSET';
+}
+const ASSET_PATH = 'Hk6FQuz5';
+export function getAssetS3Path(content) {
+  return content[ASSET_PATH];
+}
+export function setAssetS3Path(content, path) {
+  content[ASSET_PATH] = path;
+}
+export const builtInShapes = {
+  TSRelationship: {
+    id: 'TSRelationship',
+    name: 'TSRelationship',
+    title: 'Relationship',
+    schema: {
+      type: 'object',
+      properties: {
+        shapeId: {
+          type: 'string'
+        },
+        shapeName: {
+          type: 'string'
+        },
+        contentTypeId: {
+          type: 'string',
+          '@deprecationReason': 'Use shapeId instead'
+        },
+        id: {
+          type: 'string'
+        }
+      },
+      required: ['id']
+    }
+  },
+  TSColorHsl: {
+    id: 'TSColorHsl',
+    name: 'TSColorHsl',
+    title: 'Color Hsl',
+    schema: {
+      type: 'object',
+      properties: {
+        h: {
+          type: 'number'
+        },
+        a: {
+          type: 'number'
+        },
+        s: {
+          type: 'number'
+        },
+        l: {
+          type: 'number'
+        }
+      }
+    }
+  },
+  TSColorHsv: {
+    id: 'TSColorHsv',
+    name: 'TSColorHsv',
+    title: 'Color Hsv',
+    schema: {
+      type: 'object',
+      properties: {
+        h: {
+          type: 'number'
+        },
+        a: {
+          type: 'number'
+        },
+        s: {
+          type: 'number'
+        },
+        v: {
+          type: 'number'
+        }
+      }
+    }
+  },
+  TSColorRgb: {
+    id: 'TSColorRgb',
+    name: 'TSColorRgb',
+    title: 'Color Rgb',
+    schema: {
+      type: 'object',
+      properties: {
+        a: {
+          type: 'number'
+        },
+        b: {
+          type: 'number'
+        },
+        r: {
+          type: 'number'
+        },
+        g: {
+          type: 'number'
+        }
+      }
+    }
+  },
+  TSColor: {
+    id: 'TSColor',
+    name: 'TSColor',
+    title: 'Color',
+    schema: {
+      type: 'object',
+      properties: {
+        hex: {
+          type: 'string'
+        },
+        hsl: {
+          $ref: '#/shapes/TSColorHsl/schema'
+        },
+        hsv: {
+          $ref: '#/shapes/TSColorHsv/schema'
+        },
+        rgb: {
+          $ref: '#/shapes/TSColorRgb/schema'
+        }
+      }
+    }
+  },
+  Asset: {
+    id: 'ASSET',
+    name: 'Asset',
+    title: 'Asset',
+    model: {
+      type: 'multiple'
+    },
+    schema: {
+      type: 'object',
+      properties: {
+        title: {
+          type: 'string',
+          title: 'Title',
+          '@mapping': 'takeshape:local:Asset.By5tQOMc'
+        },
+        description: {
+          type: 'string',
+          title: 'Description',
+          '@mapping': 'takeshape:local:Asset.B1Zsra3fx'
+        },
+        filename: {
+          type: 'string',
+          title: 'Filename',
+          '@l10n': false,
+          minLength: 1,
+          '@mapping': 'takeshape:local:Asset.H1oYQOM9'
+        },
+        caption: {
+          type: 'object',
+          title: 'Caption',
+          '@mapping': 'takeshape:local:Asset.SyWVsd98x',
+          '@tag': 'draftjs'
+        },
+        credit: {
+          type: 'object',
+          title: 'Credit',
+          '@mapping': 'takeshape:local:Asset.Skn_i_5Ll',
+          '@tag': 'draftjs'
+        },
+        path: {
+          type: 'string',
+          title: 'Path',
+          '@l10n': false,
+          minLength: 1,
+          '@mapping': 'takeshape:local:Asset.Hk6FQuz5'
+        },
+        mimeType: {
+          type: 'string',
+          title: 'MIME type',
+          '@l10n': false,
+          '@mapping': 'takeshape:local:Asset.SyCYX_Gq'
+        },
+        sourceUrl: {
+          type: 'string',
+          title: 'Source URL',
+          '@l10n': false,
+          '@mapping': 'takeshape:local:Asset.SJXSidnXE'
+        },
+        uploadStatus: {
+          type: 'string',
+          title: 'Upload status',
+          '@l10n': false,
+          '@mapping': 'takeshape:local:Asset.ByeAYXdG9'
+        }
+      },
+      required: ['filename', 'path']
+    }
+  },
+  TsStaticSite: {
+    id: 'SITE',
+    name: 'TsStaticSite',
+    title: 'Static Site',
+    model: {
+      type: 'multiple'
+    },
+    schema: {
+      type: 'object',
+      properties: {
+        title: {
+          type: 'string',
+          title: 'Title',
+          '@l10n': false,
+          minLength: 1,
+          '@mapping': 'takeshape:local:TsStaticSite.Ski9jLuXg'
+        },
+        baseUrl: {
+          type: 'string',
+          title: 'Base URL',
+          '@l10n': false,
+          minLength: 1,
+          '@mapping': 'takeshape:local:TsStaticSite.Bk3tNmrfE'
+        },
+        provider: {
+          type: 'string',
+          default: 's3',
+          title: 'Provider',
+          '@l10n': false,
+          oneOf: [{
+            enum: ['s3'],
+            title: 'S3'
+          }, {
+            enum: ['gcs'],
+            title: 'Google Cloud Storage'
+          }, {
+            enum: ['ftp'],
+            title: 'FTP Client'
+          }, {
+            enum: ['azure'],
+            title: 'Azure Storage Account'
+          }, {
+            enum: ['netlify'],
+            title: 'Netlify'
+          }, {
+            enum: ['vercel'],
+            title: 'Vercel'
+          }],
+          '@mapping': 'takeshape:local:TsStaticSite.SkwbT2hqe'
+        },
+        idKey: {
+          type: 'string',
+          title: 'Id Key',
+          '@l10n': false,
+          minLength: 1,
+          '@mapping': 'takeshape:local:TsStaticSite.SyRhi8_me'
+        },
+        secretKey: {
+          type: 'string',
+          title: 'Secret Key',
+          '@l10n': false,
+          '@sensitive': true,
+          minLength: 1,
+          '@mapping': 'takeshape:local:TsStaticSite.BkIajLdXl'
+        },
+        destination: {
+          type: 'string',
+          title: 'Destination',
+          '@l10n': false,
+          minLength: 1,
+          '@mapping': 'takeshape:local:TsStaticSite.Hk6TsIdXl'
+        },
+        privateAcl: {
+          type: 'boolean',
+          title: 'Private ACL',
+          '@l10n': false,
+          '@mapping': 'takeshape:local:TsStaticSite.ByFe48wWU'
+        },
+        environmentVariables: {
+          type: 'array',
+          title: 'Environment Variables',
+          '@l10n': false,
+          items: {
+            $ref: '#/shapes/TsStaticSiteEnvironmentVariables/schema'
+          },
+          '@mapping': 'takeshape:local:TsStaticSite.9fj4UiNxY'
+        },
+        triggers: {
+          type: 'array',
+          title: 'Publish Triggers',
+          '@l10n': false,
+          items: {
+            $ref: '#/shapes/TsStaticSiteTriggers/schema'
+          }
+        },
+        templateHash: {
+          type: 'string',
+          title: 'Template Hash',
+          '@l10n': false,
+          '@mapping': 'takeshape:local:TsStaticSite.S1QA3GYI8'
+        }
+      },
+      required: ['title', 'provider', 'destination']
+    }
+  },
+  TsStaticSiteEnvironmentVariables: {
+    id: '9fj4UiNxY',
+    name: 'TsStaticSiteEnvironmentVariables',
+    title: 'Static Site EnvironmentVariables',
+    schema: {
+      type: 'object',
+      properties: {
+        name: {
+          type: 'string',
+          title: 'Name',
+          '@mapping': 'takeshape:local:TsStaticSite.J8sbHgfdI'
+        },
+        value: {
+          type: 'string',
+          title: 'Value',
+          '@mapping': 'takeshape:local:TsStaticSite.ndhh88DvG'
+        }
+      }
+    }
+  },
+  TsStaticSiteTriggers: {
+    id: 'TsStaticSiteTriggers',
+    name: 'TsStaticSiteTriggers',
+    title: 'Static Site Triggers',
+    schema: {
+      type: 'object',
+      properties: {
+        contentTypeId: {
+          type: 'string',
+          title: 'Content Type'
+        },
+        status: {
+          type: 'string',
+          title: 'Workflow Status'
+        }
+      }
+    }
+  }
+};
+export const builtInForms = {
+  Asset: {
+    default: {
+      order: ['title', 'description', 'caption', 'credit', 'filename', 'path', 'mimeType', 'sourceUrl', 'uploadStatus'],
+      properties: {
+        title: {
+          widget: 'singleLineText',
+          disabled: true
+        },
+        description: {
+          widget: 'paragraphText',
+          disabled: true
+        },
+        caption: {
+          widget: 'wysiwygSingleLineText',
+          disabled: true
+        },
+        credit: {
+          widget: 'wysiwygSingleLineText',
+          disabled: true
+        },
+        filename: {
+          widget: 'singleLineText',
+          disabled: true
+        },
+        path: {
+          widget: 'singleLineText',
+          disabled: true
+        },
+        mimeType: {
+          widget: 'singleLineText',
+          disabled: true
+        },
+        sourceUrl: {
+          widget: 'singleLineText',
+          disabled: true
+        },
+        uploadStatus: {
+          widget: 'singleLineText',
+          disabled: true
+        }
+      }
+    }
+  },
+  TsStaticSite: {
+    default: {
+      order: ['title', 'provider', 'destination', 'idKey', 'secretKey', 'environmentVariables'],
+      properties: {
+        title: {
+          widget: 'singleLineText',
+          disabled: true
+        },
+        provider: {
+          widget: 'dropdown',
+          disabled: true
+        },
+        destination: {
+          widget: 'singleLineText',
+          instructions: 'Deployment Bucket or FTP Host',
+          disabled: true
+        },
+        idKey: {
+          widget: 'singleLineText',
+          instructions: 'AWS Access Key ID or Google Cloud Storage Client Email or FTP Username',
+          disabled: true
+        },
+        secretKey: {
+          widget: 'sensitiveField',
+          instructions: 'AWS Secret Access Key or Google Cloud Storage Private Key or FTP Password',
+          multiline: true,
+          disabled: true
+        },
+        environmentVariables: {
+          widget: 'repeater',
+          order: ['name', 'value'],
+          disabled: true,
+          properties: {
+            name: {
+              widget: 'singleLineText',
+              disabled: true
+            },
+            value: {
+              widget: 'singleLineText',
+              disabled: true
+            }
+          }
+        }
+      }
+    },
+    generalHeader: {
+      order: ['title', 'provider', 'baseUrl'],
+      properties: {
+        title: {
+          widget: 'singleLineText',
+          disabled: true
+        },
+        provider: {
+          widget: 'dropdown',
+          disabled: true
+        },
+        baseUrl: {
+          widget: 'singleLineText',
+          disabled: true
+        }
+      }
+    },
+    generalFooter: {
+      order: ['environmentVariables', 'triggers'],
+      properties: {
+        environmentVariables: {
+          widget: 'repeater',
+          order: ['name', 'value'],
+          disabled: true,
+          properties: {
+            name: {
+              widget: 'singleLineText',
+              disabled: true
+            },
+            value: {
+              widget: 'singleLineText',
+              disabled: true
+            }
+          }
+        },
+        triggers: {
+          widget: 'repeater',
+          order: ['contentTypeId', 'status'],
+          disabled: true,
+          preview: 'siteTriggerPreview',
+          properties: {
+            contentTypeId: {
+              widget: 'dropdown',
+              disabled: true
+            },
+            status: {
+              widget: 'dropdown',
+              disabled: true
+            }
+          }
+        }
+      }
+    },
+    s3: {
+      order: ['destination', 'idKey', 'secretKey', 'privateAcl'],
+      properties: {
+        destination: {
+          widget: 'singleLineText',
+          instructions: 'Deployment Bucket Name',
+          disabled: true
+        },
+        idKey: {
+          widget: 'singleLineText',
+          instructions: 'AWS Access Key ID',
+          disabled: true
+        },
+        secretKey: {
+          widget: 'sensitiveField',
+          instructions: 'AWS Secret Access Key',
+          multiline: true,
+          disabled: true
+        },
+        privateAcl: {
+          widget: 'checkbox',
+          instructions: 'Disable public access to deployed files. This is useful when fronting S3 with CloudFront or with "Block All Public Access"',
+          disabled: true
+        }
+      }
+    },
+    gcs: {
+      order: ['destination', 'idKey', 'secretKey', 'privateAcl'],
+      properties: {
+        destination: {
+          widget: 'singleLineText',
+          instructions: 'Deployment Bucket Name',
+          disabled: true
+        },
+        idKey: {
+          widget: 'singleLineText',
+          instructions: 'Google Cloud Storage Client Email',
+          disabled: true
+        },
+        secretKey: {
+          widget: 'sensitiveField',
+          instructions: 'Google Cloud Storage Private Key',
+          multiline: true,
+          disabled: true
+        },
+        privateAcl: {
+          widget: 'checkbox',
+          instructions: 'Disable public access to deployed files.',
+          disabled: true
+        }
+      }
+    },
+    ftp: {
+      order: ['destination', 'idKey', 'secretKey'],
+      properties: {
+        destination: {
+          widget: 'singleLineText',
+          instructions: 'FTP Host',
+          disabled: true
+        },
+        idKey: {
+          widget: 'singleLineText',
+          instructions: 'FTP Username',
+          disabled: true
+        },
+        secretKey: {
+          widget: 'sensitiveField',
+          instructions: 'FTP Password',
+          multiline: true,
+          disabled: true
+        }
+      }
+    },
+    azure: {
+      order: ['destination', 'secretKey'],
+      properties: {
+        destination: {
+          widget: 'singleLineText',
+          instructions: 'Storage Account Name',
+          disabled: true
+        },
+        secretKey: {
+          widget: 'sensitiveField',
+          instructions: 'Access key',
+          multiline: true,
+          disabled: true
+        }
+      }
+    },
+    netlify: {
+      order: ['destination'],
+      properties: {
+        destination: {
+          widget: 'publishTargets',
+          itemTemplate: 'siteDropdownItem',
+          instructions: 'Choose existing or create a new site.',
+          disabled: true
+        }
+      }
+    },
+    vercel: {
+      order: ['destination'],
+      properties: {
+        destination: {
+          widget: 'publishTargets',
+          itemTemplate: 'siteDropdownItem',
+          instructions: 'Choose existing or create a new project.',
+          disabled: true
+        }
+      }
+    }
+  }
+};