@wix/patterns-fields-utils 1.0.0

package/@wix/wix-data-schema-types/lib/schema.d.ts

@@ -0,0 +1,202 @@
+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;
+    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 declare 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 declare 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 declare 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 declare 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 declare 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/lib/schema.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Storage = exports.AccessLevel = exports.PermissionRole = exports.CollectionOperation = exports.DataOperation = void 0;
+var DataOperation;
+(function (DataOperation) {
+    DataOperation["aggregate"] = "aggregate";
+    DataOperation["bulkInsert"] = "bulkInsert";
+    DataOperation["bulkRemove"] = "bulkRemove";
+    DataOperation["bulkSave"] = "bulkSave";
+    DataOperation["bulkUpdate"] = "bulkUpdate";
+    DataOperation["count"] = "count";
+    DataOperation["distinct"] = "distinct";
+    DataOperation["find"] = "find";
+    DataOperation["get"] = "get";
+    DataOperation["insert"] = "insert";
+    DataOperation["insertReference"] = "insertReference";
+    DataOperation["isReferenced"] = "isReferenced";
+    DataOperation["queryReferenced"] = "queryReferenced";
+    DataOperation["remove"] = "remove";
+    DataOperation["removeReference"] = "removeReference";
+    DataOperation["replaceReferences"] = "replaceReferences";
+    DataOperation["save"] = "save";
+    DataOperation["truncate"] = "truncate";
+    DataOperation["update"] = "update";
+    DataOperation["patch"] = "patch";
+    DataOperation["bulkPatch"] = "bulkPatch";
+})(DataOperation = exports.DataOperation || (exports.DataOperation = {}));
+var CollectionOperation;
+(function (CollectionOperation) {
+    CollectionOperation["UPDATE"] = "update";
+    CollectionOperation["REMOVE"] = "remove";
+})(CollectionOperation = exports.CollectionOperation || (exports.CollectionOperation = {}));
+var PermissionRole;
+(function (PermissionRole) {
+    /**
+     * Anyone (anonymous) can perform the operation
+     */
+    PermissionRole["anyone"] = "anyone";
+    /**
+     * User of user can perform the operation
+     */
+    PermissionRole["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.
+     */
+    PermissionRole["siteMemberAuthor"] = "siteMemberAuthor";
+    /**
+     * Site Admin can perform the operation.
+     */
+    PermissionRole["admin"] = "admin";
+})(PermissionRole = exports.PermissionRole || (exports.PermissionRole = {}));
+var AccessLevel;
+(function (AccessLevel) {
+    /** Any subject, including visitors */
+    AccessLevel["ANYONE"] = "ANYONE";
+    /** Any signed-in user (both site members and collaborators) */
+    AccessLevel["SITE_MEMBER"] = "SITE_MEMBER";
+    /** Any signed-in user, but site members only have access to own items */
+    AccessLevel["SITE_MEMBER_AUTHOR"] = "SITE_MEMBER_AUTHOR";
+    /** Site collaborator that has a role with CMS Access permission */
+    AccessLevel["CMS_EDITOR"] = "CMS_EDITOR";
+    /** CMS administrators and users or roles granted with special access */
+    AccessLevel["PRIVILEGED"] = "PRIVILEGED";
+})(AccessLevel = exports.AccessLevel || (exports.AccessLevel = {}));
+var Storage;
+(function (Storage) {
+    /**
+     * DB driver collection
+     */
+    Storage["driver"] = "driver";
+    /**
+     * User collection
+     */
+    Storage["docstore"] = "docstore";
+    /**
+     * App builder collection
+     * @deprecated
+     * `Storage.staticAppSchema` should be used instead
+     */
+    Storage["app"] = "app";
+    /**
+     * External db driver collection
+     */
+    Storage["external"] = "external";
+    /**
+     * Dynamic application collection. For example Forms collection.
+     * @deprecated
+     * `Storage.driver` should be used instead
+     */
+    Storage["dynamicApplication"] = "dynamicApplication";
+    /**
+     * Static application collection. For example Blocks collection.
+     */
+    Storage["staticAppSchema"] = "staticAppSchema";
+})(Storage = exports.Storage || (exports.Storage = {}));
+//# sourceMappingURL=schema.js.map

package/@wix/wix-data-schema-types/lib/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":";;;AA6EA,IAAY,aAsBX;AAtBD,WAAY,aAAa;IACvB,wCAAuB,CAAA;IACvB,0CAAyB,CAAA;IACzB,0CAAyB,CAAA;IACzB,sCAAqB,CAAA;IACrB,0CAAyB,CAAA;IACzB,gCAAe,CAAA;IACf,sCAAqB,CAAA;IACrB,8BAAa,CAAA;IACb,4BAAW,CAAA;IACX,kCAAiB,CAAA;IACjB,oDAAmC,CAAA;IACnC,8CAA6B,CAAA;IAC7B,oDAAmC,CAAA;IACnC,kCAAiB,CAAA;IACjB,oDAAmC,CAAA;IACnC,wDAAuC,CAAA;IACvC,8BAAa,CAAA;IACb,sCAAqB,CAAA;IACrB,kCAAiB,CAAA;IACjB,gCAAe,CAAA;IACf,wCAAuB,CAAA;AACzB,CAAC,EAtBW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAsBxB;AAED,IAAY,mBAGX;AAHD,WAAY,mBAAmB;IAC7B,wCAAiB,CAAA;IACjB,wCAAiB,CAAA;AACnB,CAAC,EAHW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAG9B;AAiBD,IAAY,cA8BX;AA9BD,WAAY,cAAc;IACxB;;OAEG;IACH,mCAAiB,CAAA;IAEjB;;OAEG;IACH,2CAAyB,CAAA;IAEzB;;;;;;;;;;;;OAYG;IACH,uDAAqC,CAAA;IAErC;;OAEG;IACH,iCAAe,CAAA;AACjB,CAAC,EA9BW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QA8BzB;AASD,IAAY,WAeX;AAfD,WAAY,WAAW;IACrB,sCAAsC;IACtC,gCAAiB,CAAA;IAEjB,+DAA+D;IAC/D,0CAA2B,CAAA;IAE3B,yEAAyE;IACzE,wDAAyC,CAAA;IAEzC,mEAAmE;IACnE,wCAAyB,CAAA;IAEzB,wEAAwE;IACxE,wCAAyB,CAAA;AAC3B,CAAC,EAfW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAetB;AAYD,IAAY,OAkCX;AAlCD,WAAY,OAAO;IACjB;;OAEG;IACH,4BAAiB,CAAA;IAEjB;;OAEG;IACH,gCAAqB,CAAA;IAErB;;;;OAIG;IACH,sBAAW,CAAA;IAEX;;OAEG;IACH,gCAAqB,CAAA;IAErB;;;;OAIG;IACH,oDAAyC,CAAA;IAEzC;;OAEG;IACH,8CAAmC,CAAA;AACrC,CAAC,EAlCW,OAAO,GAAP,eAAO,KAAP,eAAO,QAkClB"}

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

@@ -0,0 +1,45 @@
+{
+  "name": "@wix/wix-data-schema-types",
+  "version": "2.0.32",
+  "license": "MIT",
+  "author": {
+    "name": "Giedrius Grazevicius",
+    "email": "giedriusg@wix.com"
+  },
+  "scripts": {
+    "clean": "rm -rf node_modules package-lock.json",
+    "build": "tsc",
+    "lint": "tslint -p ./",
+    "lint:fix": "npm run lint -- --fix",
+    "test": "npm run build && npm run lint"
+  },
+  "publishConfig": {
+    "registry": "https://npm-cache.dev.wixpress.com/",
+    "access": "restricted"
+  },
+  "main": "./lib/index.js",
+  "devDependencies": {
+    "@types/long": "^4.0.2",
+    "@types/node": "^10.17.60",
+    "@wix/wix-data-tslint-rules": "^1.0.0",
+    "tslint": "^5.20.1",
+    "tslint-config-standard": "^7.1.0",
+    "typescript": "^4.9.5"
+  },
+  "wix": {
+    "artifact": {
+      "groupId": "com.wixpress.cloud.wix-dis",
+      "artifactId": "wix-data-schema-types",
+      "targets": {
+        "static": false,
+        "docker": false
+      }
+    }
+  },
+  "falconPackageHash": "9d350cbeb6dd249900ed095009ed083be7f3ba50399ad91fa0a59a19",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/wix-private/wix-data.git",
+    "directory": "wix-data-schema-types"
+  }
+}

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

@@ -0,0 +1,19 @@
+/**
+ * @interface Capabilities
+ * @description Capabilities that collection supports.
+ */
+export interface Capabilities {
+  indexing?: Indexing
+}
+
+/**
+ * @interface Indexing
+ * @description Defines the limits of how many indexes can be at any given time.
+ */
+export interface Indexing {
+  regular: number
+  regular1Field?: number
+  compound?: number
+  unique: number
+  total: number
+}

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

@@ -0,0 +1,6 @@
+import { PagingMode } from './pagingMode'
+
+export const DefaultMaxPageSize = {
+  [PagingMode.Offset]: 1000,
+  [PagingMode.Cursor]: 100
+}