@wix/patterns-fields-utils 1.0.0

package/@wix/wix-data-schema-types/src/plugins.ts

@@ -0,0 +1,97 @@
+import { OrderSpec } from './order'
+
+export const PUBLISHING_PLUGIN_ID = 'publishing' as const
+
+export const PUBLISH_STATUS_FIELD_KEY = '_publishStatus' as const
+export const PUBLISH_DATE_FIELD_KEY = '_publishDate' as const
+export const DRAFT_DATE_FIELD_KEY = '_draftDate' as const
+
+export enum PublishingStatus {
+  DRAFT = 'DRAFT',
+  PUBLISHED = 'PUBLISHED'
+}
+
+export interface PublishingPlugin {
+  defaultStatus: PublishingStatus
+}
+
+export const GRID_APPLESS_PLUGIN_ID = 'gridAppless'
+
+export interface GridApplessPlugin {
+  isMigrated: boolean
+}
+
+export const SINGLES_PLUGIN_ID = 'singleItem' as const
+
+export interface SinglesPlugin {
+  singleItemId: string
+}
+
+export const URLIZED_PLUGIN_ID = 'urlized' as const
+
+export enum UrlizedFormat {
+  PLAIN = 'plain',
+  ORIGINAL = 'original'
+}
+
+export interface UrlizedPlugin {
+  format: UrlizedFormat
+}
+
+export const MULTILINGUAL_PLUGIN_ID = 'multilingual' as const
+
+export interface MultilingualPlugin {
+  translatable: string[]
+}
+
+export const SHARED_PLUGIN_ID = 'shared' as const
+
+export interface SharedPlugin {}
+
+export const PAGE_LINK_PLUGIN_ID = 'persistentPageLink' as const
+export interface PageLinkPlugin {
+  isPersisted: boolean
+  isUpdatable: boolean
+}
+
+export const CMS_PLUGIN_ID = 'cms'
+export interface CmsPlugin {
+  siteSort?: {
+    sort: OrderSpec[]
+  }
+}
+
+export const CATALOG_PLUGIN_ID = 'CATALOG'
+export interface CatalogOptions {
+  name?: string
+  price?: string
+  url?: string | null
+  description?: string | null
+  image?: string | null
+  quantity?: string | null
+}
+
+export interface CatalogPlugin {
+  catalogOptions?: CatalogOptions
+}
+
+export const CATEGORIES_PLUGIN_ID = 'categories'
+export interface CategoriesPlugin {}
+
+export interface KnownSchemaPlugins {
+  [PUBLISHING_PLUGIN_ID]?: PublishingPlugin
+  [GRID_APPLESS_PLUGIN_ID]?: GridApplessPlugin
+  [SINGLES_PLUGIN_ID]?: SinglesPlugin
+  [URLIZED_PLUGIN_ID]?: UrlizedPlugin
+  [MULTILINGUAL_PLUGIN_ID]?: MultilingualPlugin
+  [SHARED_PLUGIN_ID]?: SharedPlugin
+  [PAGE_LINK_PLUGIN_ID]?: PageLinkPlugin
+  [CMS_PLUGIN_ID]?: CmsPlugin
+  [CATALOG_PLUGIN_ID]?: CatalogPlugin
+  [CATEGORIES_PLUGIN_ID]?: CategoriesPlugin
+}
+
+export type SchemaPlugins = KnownSchemaPlugins & Record<string, object>
+
+export type SchemaPluginId = keyof KnownSchemaPlugins
+export type SchemaPlugin = Required<KnownSchemaPlugins>[SchemaPluginId]

package/@wix/wix-data-schema-types/src/schema.ts

@@ -0,0 +1,222 @@
+import { Capabilities } from './capabilities'
+import { FieldSpec } from './field'
+import { OrderSpec } from './order'
+import { PagingMode } from './pagingMode'
+import { SchemaPlugins } from './plugins'
+
+/**
+ * @interface Schema
+ * @member displayName {string} - Defines UI-friendly name of a collection.
+ * @member namespace {string} - Defines to which namespace the collections belongs to.
+ * This is used for grouping collections in the editor's left side menu under Database section.
+ * @member displayNamespace {string} - Defines a UI-friendly namespace value.
+ * @member isDeleted {boolean} - Marks the schema as deleted and unavailable for use in data operations.
+ * @member id {string} - ID should be formed by concatenating namespace, slash ('/') and collection name. For example:
+ * 'Stores/Products'. This is the property that is used in Wix Data requests to refer to the collection. For example:
+ * wixData.query('Stores/Products').find()
+ * @member ownerAppId {string} - Id of app that exposes the schema. The collection will only be visible in sites
+ * that have an application with the given id provisioned.
+ * @member allowedOperations {Array<string>} - Lists Wix Data operations that are allowed in a given collection.
+ * Operations that are not available will be hidden in Content Manager, Permissions dialog and Dataset options.
+ * Wix Data however will not reject any operation performed by user from code. It is up for the driver to do so. It
+ * is recommended to reject with a meaningful error message explaining why the operation did not succeed.
+ * Returning empty array would block all filter options, returning null would allow options default for that type.
+ * @member permissions - see {@link Permissions}
+ * @member dataPermissions - general collection permission configuration (read-only)
+ * @member allowedPermissions - allowed data operations for current user, included only on-demand, see {@link AllowedDataPermissions}
+ * @member defaultSort {OrderSpec} - Denotes default sort of database if no sort is applied. This is used to communicate
+ * to the user what the sort order is, if no sort order is specified. This should be set only if default sort order
+ * exists for you collection as this is not the default order that will be passed down to find, but the order the
+ * driver applies when no order is given.
+ * @member displayField marks a field value of which will be used to represent the item in (multi-)references.
+ * When showing assigned (multi-)references Content Manager will use this field to display which items are assigned.
+ * When assigning new (multi-)reference item, this field can be used to search for the item.
+ * @member fields { [fieldName: string]: FieldSpec } - Fields specifications.
+ * @member maxPageSize {string} - Defines a maximum page size of a query supported by schema. Defaults are defined in DefaultMaxPageSize.
+ * @member storage - see {@link Storage}
+ * @member plugins - a map of plugins enabled for schema.
+ * @member version {number} - When Optimistic Locking is enabled, the version number is defined and increments on
+ * every schema change.
+ * @member ttl - number of seconds this schema can be safely cached for. We suggest a high number for schemas that are
+ * static in nature (that is user can not change them) and low number for those that can change. Schemas have little impact
+ * to data operations in a live, so it is safe to cache even schemas that change because of user actions; only exceptions are
+ * references and field deletion. Schemas are not cached in Editor segment.
+ * @member capabilities - see {@link Capabilities}
+ */
+export interface Schema {
+  displayName: string
+  namespace?: string | null
+  displayNamespace?: string | null
+  isDeleted?: boolean
+  id: string
+  ownerAppId?: string | null
+  allowedOperations?: DataOperation[]
+  collectionOperations?: CollectionOperation[]
+  permissions: Permissions | any // Allow for non-build breaking migration
+  dataPermissions?: DataPermissions
+  allowedPermissions?: AllowedDataPermissions
+  defaultSort?: OrderSpec | null
+  displayField?: string
+  fields: { [fieldName: string]: FieldSpec }
+  maxPageSize?: number
+  storage?: Storage
+  plugins?: SchemaPlugins
+  version?: number
+  ttl?: number | null
+  pagingMode?: PagingMode[]
+  capabilities?: Capabilities
+}
+
+/**
+ * @member ownerAppId - required in DB driver schemas, see {@link Schema} for more details.
+ */
+export interface DbDriverSchema extends Schema {
+  ownerAppId: string,
+  namespace: string
+}
+
+export enum DataOperation {
+  aggregate = 'aggregate',
+  bulkInsert = 'bulkInsert',
+  bulkRemove = 'bulkRemove',
+  bulkSave = 'bulkSave',
+  bulkUpdate = 'bulkUpdate',
+  count = 'count',
+  distinct = 'distinct',
+  find = 'find',
+  get = 'get',
+  insert = 'insert',
+  insertReference = 'insertReference',
+  isReferenced = 'isReferenced',
+  queryReferenced = 'queryReferenced',
+  remove = 'remove',
+  removeReference = 'removeReference',
+  replaceReferences = 'replaceReferences',
+  save = 'save',
+  truncate = 'truncate',
+  update = 'update',
+  patch = 'patch',
+  bulkPatch = 'bulkPatch'
+}
+
+export enum CollectionOperation {
+  UPDATE = 'update',
+  REMOVE = 'remove'
+}
+
+/**
+ * Defines permissions to be shown in Content Manager. User
+ * will see a read only list of permissions applied. The items
+ * displayed are determined from allowedOperations and the
+ * values are specified in this data structure.
+ *
+ * @deprecated use allowedPermissions to check current user or data permission service to configure permissions
+ */
+export interface Permissions {
+  read?: PermissionRole
+  update?: PermissionRole
+  insert?: PermissionRole
+  remove?: PermissionRole
+}
+
+export enum PermissionRole {
+  /**
+   * Anyone (anonymous) can perform the operation
+   */
+  anyone = 'anyone',
+
+  /**
+   * User of user can perform the operation
+   */
+  siteMember = 'siteMember',
+
+  /**
+   * User of user who is the owner (producer) of the
+   * data can perform the operation.
+   *
+   * In regular Wix Data collections, this allows
+   * performing operation on an item if _owner field
+   * matches the currently logged Site Member id.
+   *
+   * In case of DB drivers, this can match the
+   * ownership that is appropriate to vertical, ex.:
+   * UoU can see his purchases, or contact can see
+   * his details.
+   */
+  siteMemberAuthor = 'siteMemberAuthor',
+
+  /**
+   * Site Admin can perform the operation.
+   */
+  admin = 'admin'
+}
+
+export interface DataPermissions {
+  itemRead: AccessLevel
+  itemInsert: AccessLevel
+  itemUpdate: AccessLevel
+  itemRemove: AccessLevel
+}
+
+export enum AccessLevel {
+  /** Any subject, including visitors */
+  ANYONE = 'ANYONE',
+
+  /** Any signed-in user (both site members and collaborators) */
+  SITE_MEMBER = 'SITE_MEMBER',
+
+  /** Any signed-in user, but site members only have access to own items */
+  SITE_MEMBER_AUTHOR = 'SITE_MEMBER_AUTHOR',
+
+  /** Site collaborator that has a role with CMS Access permission */
+  CMS_EDITOR = 'CMS_EDITOR',
+
+  /** CMS administrators and users or roles granted with special access */
+  PRIVILEGED = 'PRIVILEGED'
+}
+
+/**
+ * Defines actual allowed data operations
+ */
+export interface AllowedDataPermissions {
+  itemRead: boolean
+  itemInsert: boolean
+  itemUpdate: boolean
+  itemRemove: boolean
+}
+
+export enum Storage {
+  /**
+   * DB driver collection
+   */
+  driver = 'driver',
+
+  /**
+   * User collection
+   */
+  docstore = 'docstore',
+
+  /**
+   * App builder collection
+   * @deprecated
+   * `Storage.staticAppSchema` should be used instead
+   */
+  app = 'app',
+
+  /**
+   * External db driver collection
+   */
+  external = 'external',
+
+  /**
+   * Dynamic application collection. For example Forms collection.
+   * @deprecated
+   * `Storage.driver` should be used instead
+   */
+  dynamicApplication = 'dynamicApplication',
+
+  /**
+   * Static application collection. For example Blocks collection.
+   */
+  staticAppSchema = 'staticAppSchema'
+}

package/@wix/wix-data-schema-types/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "es2017",
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "declaration": true,
+    "moduleResolution": "node",
+    "sourceMap": true,
+    "outDir": "lib",
+    "baseUrl": "./src",
+    "skipLibCheck": true
+  },
+  "compileOnSave": true,
+  "include": [
+    "src/**/*"
+  ]
+}

package/@wix/wix-data-schema-types/tslint.json

@@ -0,0 +1,3 @@
+{
+  "extends": "@wix/wix-data-tslint-rules"
+}

package/dist/cjs/index.js

@@ -0,0 +1,4 @@
+"use strict";
+
+exports.__esModule = true;
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["../../src/index.ts"],"sourcesContent":["/**\n * @wix/patterns-fields-utils\n *\n * This package bundles various utilities and dependencies for fields.\n * Bundled packages are copied to the @wix/ directory and can be imported from there.\n *\n * Available bundled packages:\n * - @wix/patterns-fields-bundled-organize-media (photography organize media)\n * - @wix/patterns-fields-bundled-cm-media-utils (media URI parsing and URL generation)\n */\n\nexport {};\n"],"mappings":"","ignoreList":[]}

package/dist/esm/index.js

@@ -0,0 +1,12 @@
+/**
+ * @wix/patterns-fields-utils
+ *
+ * This package bundles various utilities and dependencies for fields.
+ * Bundled packages are copied to the @wix/ directory and can be imported from there.
+ *
+ * Available bundled packages:
+ * - @wix/patterns-fields-bundled-organize-media (photography organize media)
+ * - @wix/patterns-fields-bundled-cm-media-utils (media URI parsing and URL generation)
+ */
+export {};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG"}

package/dist/types/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @wix/patterns-fields-utils
+ *
+ * This package bundles various utilities and dependencies for fields.
+ * Bundled packages are copied to the @wix/ directory and can be imported from there.
+ *
+ * Available bundled packages:
+ * - @wix/patterns-fields-bundled-organize-media (photography organize media)
+ * - @wix/patterns-fields-bundled-cm-media-utils (media URI parsing and URL generation)
+ */
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,CAAC"}

package/package.json

@@ -0,0 +1,87 @@
+{
+  "name": "@wix/patterns-fields-utils",
+  "version": "1.0.0",
+  "license": "UNLICENSED",
+  "author": {
+    "name": "Kobi",
+    "email": "kobia@wix.com"
+  },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "sideEffects": false,
+  "scripts": {
+    "build": "yarn copy:bundled-modules && yoshi-library build",
+    "copy:bundled-modules": "ts-node -T --project tsconfig.scripts.json ./scripts/copy-bundled-modules.ts",
+    "start": "yoshi-library start",
+    "test": ":",
+    "lint": "yoshi-library lint",
+    "type-check": "tsc --noEmit"
+  },
+  "files": [
+    "dist/cjs",
+    "dist/esm",
+    "dist/types",
+    "@wix"
+  ],
+  "dependencies": {
+    "@babel/runtime": "^7.0.0",
+    "classnames": "^2.5.1",
+    "lodash": "^4.17.21",
+    "path-parse": "^1.0.7",
+    "react-draggable": "^4.4.6",
+    "react-measure": "^2.5.2",
+    "tslib": "^2.0.0"
+  },
+  "devDependencies": {
+    "@wix/eslint-config-yoshi": "^6.74.0",
+    "@wix/jest-yoshi-preset": "^6.74.0",
+    "@wix/patterns-fields-bundled-cm-media-utils": "1.0.0",
+    "@wix/patterns-fields-bundled-organize-media": "1.0.0",
+    "@wix/wix-data-schema-types": "^2.0.26",
+    "@wix/yoshi-flow-library": "^6.74.0",
+    "ts-node": "^10.9.1",
+    "typescript": "~4.9.5"
+  },
+  "peerDependencies": {
+    "react": "^16.8.0 || ^18.0.0",
+    "react-dom": "^16.8.0 || ^18.0.0"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    }
+  },
+  "jest": {
+    "preset": "@wix/jest-yoshi-preset"
+  },
+  "eslintConfig": {
+    "extends": "@wix/eslint-config-yoshi",
+    "rules": {
+      "prettier/prettier": [
+        "warn",
+        {
+          "singleQuote": true,
+          "trailingComma": "all"
+        },
+        {
+          "usePrettierrc": false
+        }
+      ]
+    }
+  },
+  "wix": {
+    "artifact": {
+      "groupId": "com.wixpress",
+      "artifactId": "patterns-fields-utils"
+    }
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "falconPackageHash": "dfa03e4129a3684d8c68060b0468ae2f1d83fbc0654d169bc3cbbc85"
+}