@api-client/core 0.6.4 → 0.6.7

package/build/src/models/data/DataProperty.d.ts

@@ -0,0 +1,159 @@
+import { IThing, Thing } from "../Thing.js";
+import { DataNamespace } from "./DataNamespace.js";
+import { IDataPropertySchema } from "./DataPropertySchema.js";
+export declare type DataPropertyType = 'string' | 'number' | 'nil' | 'boolean' | 'date' | 'datetime' | 'time' | 'bytes' | 'any' | 'file';
+export declare const DataPropertyTypes: DataPropertyType[];
+export declare enum DataPropertyList {
+    string = "string",
+    number = "number",
+    nil = "nil",
+    boolean = "boolean",
+    date = "date",
+    datetime = "datetime",
+    time = "time",
+    bytes = "bytes",
+    any = "any",
+    file = "file"
+}
+export declare const Kind = "Core#DataProperty";
+export interface IPropertySchema<T> {
+    /**
+     * Whether it is a general schema for the property.
+     * All other schemas inherit from this one. This allows creating global schema description
+     * like examples, default values, minimum value, etc and then use it as a base to generate specific formats.
+     *
+     * A property may not have a global schema.
+     */
+    global?: boolean;
+    /**
+     * The mime type this schema describes.
+     * For JSON it is `application/json`, for XML it is `application/xml` (or `text/xml`) adn so on.
+     *
+     * Note, when this value is missing then it is assumed that the schema is `global`.
+     */
+    format?: string;
+    /**
+     * The schema definition.
+     */
+    value: IDataPropertySchema<T>;
+}
+export interface IDataProperty {
+    kind: typeof Kind;
+    /**
+     * The key of the namespace.
+     */
+    key: string;
+    /**
+     * The data property description.
+     */
+    info: IThing;
+    /**
+     * Wether the data property is required.
+     */
+    required?: boolean;
+    /**
+     * Whether the data property allows multiple items.
+     */
+    multiple?: boolean;
+    /**
+     * Whether this property describes a primary key of the entity.
+     */
+    primary?: boolean;
+    /**
+     * Whether this property describes an indexed property of the entity.
+     */
+    index?: boolean;
+    /**
+     * Optional general purpose tags for the UI.
+     */
+    tags?: string[];
+    /**
+     * For future use.
+     *
+     * The keys of the taxonomy items associated with the property.
+     */
+    taxonomy?: string[];
+    /**
+     * The data type for this property.
+     * Note, not all schemas support the same type. For example, defining `sint32`
+     * works for protocol buffers but does not for JSON. In such case we use default
+     * translation `sint32` -> `number`. Another way it to create
+     * a derivative entity for specific schema to describe specific schema case.
+     */
+    type: DataPropertyType;
+    /**
+     * While the `DataProperty` describes the general shape of the data and can be used to
+     * model the structure of the data in the system, a schema describes hwo the data
+     * should be serialized into a specific format. This allows adding example values,
+     * default values, specifying data format, etc. The assumption here is
+     * that with enough specifics provided by the user (a domain specialist)
+     * we can automatically generate a schema for the given format.
+     */
+    schemas?: IPropertySchema<unknown>[];
+}
+export declare class DataProperty {
+    protected root: DataNamespace;
+    kind: string;
+    key: string;
+    /**
+     * The description of the data namespace.
+     */
+    info: Thing;
+    /**
+     * Wether the data property is required.
+     */
+    required?: boolean;
+    /**
+     * Whether the data property allows multiple items.
+     */
+    multiple?: boolean;
+    /**
+     * Whether this property describes a primary key of the entity.
+     */
+    primary?: boolean;
+    /**
+     * Whether this property describes an indexed property of the entity.
+     */
+    index?: boolean;
+    /**
+     * Optional general purpose tags for the UI.
+     */
+    tags: string[];
+    /**
+     * Reserved for future use.
+     *
+     * The keys of the taxonomy items associated with the property.
+     */
+    taxonomy: string[];
+    /**
+     * The data type for this property.
+     * Note, not all schemas support the same type. For example, defining `sint32`
+     * works for protocol buffers but does not for JSON. In such case we use default
+     * translation `sint32` -> `number`. Another way it to create
+     * a derivative entity for specific schema to describe specific schema case.
+     */
+    type: DataPropertyType;
+    /**
+     * While the `DataProperty` describes the general shape of the data and can be used to
+     * model the structure of the data in the system, a schema describes hwo the data
+     * should be serialized into a specific format. This allows adding example values,
+     * default values, specifying data format, etc. The assumption here is
+     * that with enough specifics provided by the user (a domain specialist)
+     * we can automatically generate a schema for the given format.
+     */
+    schemas: IPropertySchema<unknown>[];
+    static get supportedTypes(): DataPropertyType[];
+    static fromName(root: DataNamespace, name: string): DataProperty;
+    static fromType(root: DataNamespace, type: DataPropertyType): DataProperty;
+    /**
+     * @param input The data property definition to restore.
+     */
+    constructor(root: DataNamespace, input?: string | IDataProperty);
+    new(init: IDataProperty): void;
+    static isDataProperty(input: unknown): boolean;
+    toJSON(): IDataProperty;
+    /**
+     * Removes self from the parent entity and the namespace definition.
+     */
+    remove(): void;
+}

package/build/src/models/data/DataProperty.js

@@ -0,0 +1,216 @@
+import { Thing } from "../Thing.js";
+import v4 from '../../lib/uuid.js';
+export const DataPropertyTypes = [
+    'string', 'number', 'nil', 'boolean', 'date', 'datetime', 'time', 'bytes', 'any', 'file'
+];
+export var DataPropertyList;
+(function (DataPropertyList) {
+    DataPropertyList["string"] = "string";
+    DataPropertyList["number"] = "number";
+    DataPropertyList["nil"] = "nil";
+    DataPropertyList["boolean"] = "boolean";
+    DataPropertyList["date"] = "date";
+    DataPropertyList["datetime"] = "datetime";
+    DataPropertyList["time"] = "time";
+    DataPropertyList["bytes"] = "bytes";
+    DataPropertyList["any"] = "any";
+    DataPropertyList["file"] = "file";
+})(DataPropertyList || (DataPropertyList = {}));
+export const Kind = 'Core#DataProperty';
+export class DataProperty {
+    root;
+    kind = Kind;
+    key = '';
+    /**
+     * The description of the data namespace.
+     */
+    info = Thing.fromName('');
+    /**
+     * Wether the data property is required.
+     */
+    required;
+    /**
+     * Whether the data property allows multiple items.
+     */
+    multiple;
+    /**
+     * Whether this property describes a primary key of the entity.
+     */
+    primary;
+    /**
+     * Whether this property describes an indexed property of the entity.
+     */
+    index;
+    /**
+     * Optional general purpose tags for the UI.
+     */
+    tags = [];
+    /**
+     * Reserved for future use.
+     *
+     * The keys of the taxonomy items associated with the property.
+     */
+    taxonomy = [];
+    /**
+     * The data type for this property.
+     * Note, not all schemas support the same type. For example, defining `sint32`
+     * works for protocol buffers but does not for JSON. In such case we use default
+     * translation `sint32` -> `number`. Another way it to create
+     * a derivative entity for specific schema to describe specific schema case.
+     */
+    type = 'string';
+    /**
+     * While the `DataProperty` describes the general shape of the data and can be used to
+     * model the structure of the data in the system, a schema describes hwo the data
+     * should be serialized into a specific format. This allows adding example values,
+     * default values, specifying data format, etc. The assumption here is
+     * that with enough specifics provided by the user (a domain specialist)
+     * we can automatically generate a schema for the given format.
+     */
+    schemas = [];
+    static get supportedTypes() {
+        return [...DataPropertyTypes];
+    }
+    static fromName(root, name) {
+        const property = new DataProperty(root);
+        property.info = Thing.fromName(name);
+        return property;
+    }
+    static fromType(root, type) {
+        const assoc = new DataProperty(root);
+        assoc.type = type;
+        return assoc;
+    }
+    /**
+     * @param input The data property definition to restore.
+     */
+    constructor(root, input) {
+        this.root = root;
+        let init;
+        if (typeof input === 'string') {
+            init = JSON.parse(input);
+        }
+        else if (typeof input === 'object') {
+            init = input;
+        }
+        else {
+            init = {
+                kind: Kind,
+                key: v4(),
+                info: Thing.fromName('').toJSON(),
+                type: 'string',
+            };
+        }
+        this.new(init);
+    }
+    new(init) {
+        if (!DataProperty.isDataProperty(init)) {
+            throw new Error(`Not a data property.`);
+        }
+        const { info, key = v4(), kind = Kind, multiple, required, type = DataPropertyList.string, index, primary, tags, taxonomy, schemas } = init;
+        this.kind = kind;
+        this.key = key;
+        this.type = type;
+        if (info) {
+            this.info = new Thing(info);
+        }
+        else {
+            this.info = Thing.fromName('');
+        }
+        if (typeof multiple === 'boolean') {
+            this.multiple = multiple;
+        }
+        else {
+            this.multiple = undefined;
+        }
+        if (typeof required === 'boolean') {
+            this.required = required;
+        }
+        else {
+            this.required = undefined;
+        }
+        if (typeof index === 'boolean') {
+            this.index = index;
+        }
+        else {
+            this.index = undefined;
+        }
+        if (typeof primary === 'boolean') {
+            this.primary = primary;
+        }
+        else {
+            this.primary = undefined;
+        }
+        if (Array.isArray(tags)) {
+            this.tags = [...tags];
+        }
+        else {
+            this.tags = [];
+        }
+        if (Array.isArray(taxonomy)) {
+            this.taxonomy = [...taxonomy];
+        }
+        else {
+            this.taxonomy = [];
+        }
+        if (Array.isArray(schemas)) {
+            this.schemas = schemas.map(i => ({ ...i }));
+        }
+        else {
+            this.schemas = [];
+        }
+    }
+    static isDataProperty(input) {
+        const typed = input;
+        if (!input || typed.kind !== Kind) {
+            return false;
+        }
+        return true;
+    }
+    toJSON() {
+        const result = {
+            kind: Kind,
+            info: this.info.toJSON(),
+            key: this.key,
+            type: this.type || DataPropertyList.string,
+        };
+        if (typeof this.index === 'boolean') {
+            result.index = this.index;
+        }
+        if (typeof this.primary === 'boolean') {
+            result.primary = this.primary;
+        }
+        if (typeof this.multiple === 'boolean') {
+            result.multiple = this.multiple;
+        }
+        if (typeof this.required === 'boolean') {
+            result.required = this.required;
+        }
+        if (Array.isArray(this.tags) && this.tags.length) {
+            result.tags = [...this.tags];
+        }
+        if (Array.isArray(this.taxonomy) && this.taxonomy.length) {
+            result.taxonomy = [...this.taxonomy];
+        }
+        if (Array.isArray(this.schemas) && this.schemas.length) {
+            result.schemas = this.schemas.map(i => ({ ...i }));
+        }
+        return result;
+    }
+    /**
+     * Removes self from the parent entity and the namespace definition.
+     */
+    remove() {
+        const { root } = this;
+        const entity = root.definitions.entities.find(i => i.properties.some(j => j === this));
+        if (entity) {
+            const assocIndex = entity.properties.findIndex(i => i === this);
+            entity.properties.splice(assocIndex, 1);
+        }
+        const defIndex = this.root.definitions.properties.findIndex(i => i.key === this.key);
+        if (defIndex >= 0) {
+            this.root.definitions.properties.splice(defIndex, 1);
+        }
+    }
+}
+//# sourceMappingURL=DataProperty.js.map

package/build/src/models/data/DataProperty.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataProperty.js","sourceRoot":"","sources":["../../../../src/models/data/DataProperty.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,KAAK,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAMnC,MAAM,CAAC,MAAM,iBAAiB,GAAuB;IACnD,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM;CACzF,CAAC;AAEF,MAAM,CAAN,IAAY,gBAWX;AAXD,WAAY,gBAAgB;IAC1B,qCAAiB,CAAA;IACjB,qCAAiB,CAAA;IACjB,+BAAW,CAAA;IACX,uCAAmB,CAAA;IACnB,iCAAa,CAAA;IACb,yCAAqB,CAAA;IACrB,iCAAa,CAAA;IACb,mCAAe,CAAA;IACf,+BAAW,CAAA;IACX,iCAAa,CAAA;AACf,CAAC,EAXW,gBAAgB,KAAhB,gBAAgB,QAW3B;AAED,MAAM,CAAC,MAAM,IAAI,GAAG,mBAAmB,CAAC;AAgFxC,MAAM,OAAO,YAAY;IAgFD;IA/EtB,IAAI,GAAG,IAAI,CAAC;IAEZ,GAAG,GAAG,EAAE,CAAC;IAET;;OAEG;IACH,IAAI,GAAU,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEjC;;OAEG;IACH,QAAQ,CAAW;IAEnB;;OAEG;IACH,QAAQ,CAAW;IAEnB;;OAEG;IACH,OAAO,CAAW;IAElB;;OAEG;IACH,KAAK,CAAW;IAEhB;;OAEG;IACH,IAAI,GAAa,EAAE,CAAC;IAEpB;;;;OAIG;IACH,QAAQ,GAAa,EAAE,CAAC;IAExB;;;;;;OAMG;IACH,IAAI,GAAqB,QAAQ,CAAC;IAElC;;;;;;;OAOG;IACH,OAAO,GAA+B,EAAE,CAAC;IAEzC,MAAM,KAAK,cAAc;QACvB,OAAO,CAAC,GAAG,iBAAiB,CAAC,CAAC;IAChC,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,IAAmB,EAAE,IAAY;QAC/C,MAAM,QAAQ,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC;QACxC,QAAQ,CAAC,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACrC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,IAAmB,EAAE,IAAsB;QACzD,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC;QACrC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;QAClB,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACH,YAAsB,IAAmB,EAAE,KAA8B;QAAnD,SAAI,GAAJ,IAAI,CAAe;QACvC,IAAI,IAAmB,CAAC;QACxB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;SAC1B;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YACpC,IAAI,GAAG,KAAK,CAAC;SACd;aAAM;YACL,IAAI,GAAG;gBACL,IAAI,EAAE,IAAI;gBACV,GAAG,EAAE,EAAE,EAAE;gBACT,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE;gBACjC,IAAI,EAAE,QAAQ;aACf,CAAC;SACH;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED,GAAG,CAAC,IAAmB;QACrB,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE;YACtC,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;SACzC;QACD,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,EAAE,EAAE,EAAE,IAAI,GAAG,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,GAAG,gBAAgB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAC5I,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,IAAI,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC;SAC7B;aAAM;YACL,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;SAChC;QACD,IAAI,OAAO,QAAQ,KAAK,SAAS,EAAE;YACjC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC1B;aAAM;YACL,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;SAC3B;QACD,IAAI,OAAO,QAAQ,KAAK,SAAS,EAAE;YACjC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC1B;aAAM;YACL,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;SAC3B;QACD,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE;YAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;SACpB;aAAM;YACL,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;SACxB;QACD,IAAI,OAAO,OAAO,KAAK,SAAS,EAAE;YAChC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;SACxB;aAAM;YACL,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;SAC1B;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACvB,IAAI,CAAC,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;SACvB;aAAM;YACL,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;SAChB;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YAC3B,IAAI,CAAC,QAAQ,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC;SAC/B;aAAM;YACL,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;SACpB;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YAC1B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;SAC7C;aAAM;YACL,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;SACnB;IACH,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,KAAc;QAClC,MAAM,KAAK,GAAG,KAAsB,CAAC;QACrC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,EAAE;YACjC,OAAO,KAAK,CAAC;SACd;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAkB;YAC5B,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACxB,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,gBAAgB,CAAC,MAAM;SAC3C,CAAC;QACF,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE;YACnC,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;SAC3B;QACD,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE;YACrC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;SAC/B;QACD,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE;YACtC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;SACjC;QACD,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE;YACtC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;SACjC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAChD,MAAM,CAAC,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;SAC9B;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;YACxD,MAAM,CAAC,QAAQ,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;SACtC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;YACtD,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;SACpD;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QACtB,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;QACvF,IAAI,MAAM,EAAE;YACV,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;YAChE,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;SACzC;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC;QACrF,IAAI,QAAQ,IAAI,CAAC,EAAE;YACjB,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;SACtD;IACH,CAAC;CACF"}

package/build/src/models/data/DataPropertySchema.d.ts

@@ -0,0 +1,125 @@
+export declare type NumberFormat = 'integer' | 'float' | 'long' | 'double' | 'int32' | 'int64' | 'uint32' | 'uint64' | 'sint32' | 'sint64' | 'fixed32' | 'fixed64' | 'sfixed32' | 'sfixed64';
+export declare const NumberFormats: NumberFormat[];
+export declare enum NumberFormatList {
+    integer = "integer",
+    float = "float",
+    int32 = "int32",
+    int64 = "int64",
+    uint32 = "uint32",
+    uint64 = "uint64",
+    sint32 = "sint32",
+    sint64 = "sint64",
+    fixed32 = "fixed32",
+    fixed64 = "fixed64",
+    sfixed32 = "sfixed32",
+    sfixed64 = "sfixed64",
+    double = "double"
+}
+export declare type DateFormat = 'rfc3339' | 'rfc2616';
+export declare const DateFormats: DateFormat[];
+export declare enum DateFormatList {
+    /**
+     * The "date-time" notation of RFC3339
+     */
+    rfc3339 = "rfc3339",
+    /**
+     * The format defined in RFC2616.
+     */
+    rfc2616 = "rfc2616"
+}
+/**
+ * The difference between the DataProperty and this is that the `DataProperty` describes the general shape of
+ * the data and `IDataPropertySchema` describes how this property is translated into a specific format
+ * (like JSON, Protocol Buffer, XML, etc)
+ */
+export interface IDataPropertySchema<T> {
+    /**
+     * The default value for the property.
+     */
+    default?: T;
+    /**
+     * Enum values for the property.
+     */
+    enum?: T[];
+    /**
+     * The example value for the property.
+     */
+    examples?: T[];
+    /**
+     * The format of a `number` or `datetime` type.
+     */
+    format?: NumberFormat | DateFormat;
+    /**
+     * Minimum length of the string or a file. Value MUST be equal to or greater than 0.
+     */
+    minLength?: number;
+    /**
+     * The minimum length of the string or a file. Value MUST be equal to or greater than 0.
+     */
+    maxLength?: number;
+    /**
+     * Regular expression that this string MUST match.
+     */
+    pattern?: string;
+    /**
+     * The minimum value.
+     */
+    minimum?: number;
+    /**
+     * The maximum value.
+     */
+    maximum?: number;
+    /**
+     * A numeric instance is valid against "multipleOf" if the result of dividing the instance by this
+     * value is an integer.
+     */
+    multipleOf?: number;
+    /**
+     * A list of valid content-type strings for the file. The file type `*\/*` is a valid value.
+     */
+    fileTypes?: string[];
+    /**
+     * Describes XML specific serialization.
+     */
+    xml?: {
+        /**
+         * Whether is property should be represented as an attribute of the parent entity.
+         *
+         * ```
+         * <Person name="John Doe"></Person>
+         * ```
+         */
+        attribute?: boolean;
+        /**
+         * The name of the attribute or a wrapped property to use when serializing the property.
+         *
+         * ```
+         * <Person fullName="John Doe"></Person>
+         * ```
+         */
+        name?: string;
+        /**
+         * When the property is an array (has the `multiple` set to true)
+         * then it tells that the list of values should be wrapped with a parent
+         * element:
+         *
+         * ```
+         * <Person>
+         *  <Person fullName="John Doe"></Person>
+         * </Person>
+         * ```
+         *
+         * Use this with the combination with `name` to describe the name of the wrapped
+         * element
+         *
+         * ```
+         * <people>
+         *  <Person fullName="John Doe"></Person>
+         * </people>
+         * ```
+         *
+         * Note, this is mutually exclusive with `attribute`.
+         */
+        wrapped?: boolean;
+    };
+}

package/build/src/models/data/DataPropertySchema.js

@@ -0,0 +1,33 @@
+export const NumberFormats = [
+    'integer', 'float', 'long', 'double', 'int32', 'int64', 'uint32', 'uint64', 'sint32', 'sint64', 'fixed32', 'fixed64',
+    'sfixed32', 'sfixed64'
+];
+export var NumberFormatList;
+(function (NumberFormatList) {
+    NumberFormatList["integer"] = "integer";
+    NumberFormatList["float"] = "float";
+    NumberFormatList["int32"] = "int32";
+    NumberFormatList["int64"] = "int64";
+    NumberFormatList["uint32"] = "uint32";
+    NumberFormatList["uint64"] = "uint64";
+    NumberFormatList["sint32"] = "sint32";
+    NumberFormatList["sint64"] = "sint64";
+    NumberFormatList["fixed32"] = "fixed32";
+    NumberFormatList["fixed64"] = "fixed64";
+    NumberFormatList["sfixed32"] = "sfixed32";
+    NumberFormatList["sfixed64"] = "sfixed64";
+    NumberFormatList["double"] = "double";
+})(NumberFormatList || (NumberFormatList = {}));
+export const DateFormats = ['rfc3339', 'rfc2616'];
+export var DateFormatList;
+(function (DateFormatList) {
+    /**
+     * The "date-time" notation of RFC3339
+     */
+    DateFormatList["rfc3339"] = "rfc3339";
+    /**
+     * The format defined in RFC2616.
+     */
+    DateFormatList["rfc2616"] = "rfc2616";
+})(DateFormatList || (DateFormatList = {}));
+//# sourceMappingURL=DataPropertySchema.js.map

package/build/src/models/data/DataPropertySchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataPropertySchema.js","sourceRoot":"","sources":["../../../../src/models/data/DataPropertySchema.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,aAAa,GAAmB;IAC3C,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS;IACpH,UAAU,EAAE,UAAU;CACvB,CAAC;AAEF,MAAM,CAAN,IAAY,gBAcX;AAdD,WAAY,gBAAgB;IAC1B,uCAAmB,CAAA;IACnB,mCAAe,CAAA;IACf,mCAAe,CAAA;IACf,mCAAe,CAAA;IACf,qCAAiB,CAAA;IACjB,qCAAiB,CAAA;IACjB,qCAAiB,CAAA;IACjB,qCAAiB,CAAA;IACjB,uCAAmB,CAAA;IACnB,uCAAmB,CAAA;IACnB,yCAAqB,CAAA;IACrB,yCAAqB,CAAA;IACrB,qCAAiB,CAAA;AACnB,CAAC,EAdW,gBAAgB,KAAhB,gBAAgB,QAc3B;AAGD,MAAM,CAAC,MAAM,WAAW,GAAiB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;AAChE,MAAM,CAAN,IAAY,cASX;AATD,WAAY,cAAc;IACxB;;OAEG;IACH,qCAAmB,CAAA;IACnB;;OAEG;IACH,qCAAmB,CAAA;AACrB,CAAC,EATW,cAAc,KAAd,cAAc,QASzB"}

package/build/src/models/legacy/Normalizer.js

@@ -1,5 +1,5 @@
 import { Kind as AuthKind } from '../RequestAuthorization.js';
-import { hasBuffer } from '../../lib/transformers/PayloadSerializer.js';
+import { hasBuffer } from '../../Platform.js';
 export class Normalizer {
     static normalizeRequest(request) {
         if (!request) {

package/build/src/models/legacy/Normalizer.js.map

@@ -1 +1 @@
-{"version":3,"file":"Normalizer.js","sourceRoot":"","sources":["../../../../src/models/legacy/Normalizer.ts"],"names":[],"mappings":"AAGA,OAAO,EAAyB,IAAI,IAAI,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACrF,OAAO,EAAE,SAAS,EAAE,MAAM,6CAA6C,CAAC;AAExE,MAAM,OAAO,UAAU;IACrB,MAAM,CAAC,gBAAgB,CAAC,OAAgB;QACtC,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,KAAK,GAAG,EAAE,GAAG,OAAiB,EAAS,CAAC;QAC9C,IAAI,KAAK,CAAC,aAAa,EAAE;YACvB,MAAM,KAAK,GAAG,KAAwB,CAAC;YACvC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;gBACnB,KAAK,CAAC,QAAQ,GAAG,EAAE,CAAC;aACrB;YACD,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC;YAC5D,OAAO,KAAK,CAAC,aAAa,CAAC;SAC5B;QACD,MAAM,QAAQ,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;QAC7C,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACjC,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE;gBAClD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC;aACnB;QACH,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE;YAClB,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;SAC5B;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE;YAClB,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;SAC/B;QACD,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;YACnB,MAAM,GAAG,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACpC,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YACzB,KAAK,CAAC,QAAQ,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;SAChC;QAED,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE;YACf,IAAI,KAAK,CAAC,IAAI,EAAE;gBACd,KAAK,CAAC,IAAI,GAAG,OAAO,CAAC;aACtB;iBAAM;gBACL,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC;aACxB;SACF;aAAM,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,EAAE;YAClE,KAAK,CAAC,IAAI,GAAG,OAAO,CAAC;SACtB;QACD,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE;YAC1C,KAAK,CAAC,GAAG,GAAG,UAAU,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;SACjD;QAED,OAAO,UAAU,CAAC,sBAAsB,CAAC,KAA4C,CAAC,CAAC;IACzF,CAAC;IAED,MAAM,CAAC,iBAAiB,CAAC,OAA0B;QACjD,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;QAChC,MAAM,CAAC,GAAG,IAAI,IAAI,EAAE,CAAC;QACrB,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACvB,MAAM,IAAI,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;QACvC,OAAO,GAAG,IAAI,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;IACvC,CAAC;IAED,MAAM,CAAC,sBAAsB,CAAI,OAAU;QACzC,MAAM,KAAK,GAAG,OAAc,CAAC;QAC7B,MAAM,EAAE,IAAI,GAAG,EAAE,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC;QACtC,IAAI,CAAC,QAAQ,EAAE;YACb,OAAO,OAAO,CAAC;SAChB;QACD,MAAM,WAAW,GAA0B;YACzC,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,IAAI;YACX,IAAI,EAAE,QAAQ;SACf,CAAC;QACF,MAAM,IAAI,GAAG,EAAE,GAAG,KAAK,EAAE,CAAC;QAC1B,IAAI,CAAC,aAAa,GAAG,CAAC,WAAW,CAAC,CAAC;QACnC,OAAO,IAAI,CAAC,IAAI,CAAC;QACjB,OAAO,IAAI,CAAC,QAAQ,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,yBAAyB,CAAC,IAA8D;QAC7F,IAAI,CAAC,IAAI,EAAE;YACT,OAAO,IAAI,CAAC;SACb;QACD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC5B,OAAO,IAAI,CAAC;SACb;QACD,IAAI,SAAS,IAAI,IAAI,YAAY,MAAM,EAAE;YACvC,OAAO,IAAI,CAAC;SACb;QACD,IAAI,IAAI,YAAY,WAAW,EAAE;YAC/B,OAAO,IAAI,CAAC;SACb;QACD,MAAM,KAAK,GAAG,IAAgC,CAAC;QAC/C,IAAI,KAAK,CAAC,IAAI,KAAK,aAAa,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,SAAS,CAAC,EAAE;YAC3E,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC9C,OAAO,MAAM,CAAC;SACf;QACD,IAAI,SAAS,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;YACxC,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;SAChC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF"}
+{"version":3,"file":"Normalizer.js","sourceRoot":"","sources":["../../../../src/models/legacy/Normalizer.ts"],"names":[],"mappings":"AAGA,OAAO,EAAyB,IAAI,IAAI,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACrF,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE9C,MAAM,OAAO,UAAU;IACrB,MAAM,CAAC,gBAAgB,CAAC,OAAgB;QACtC,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,KAAK,GAAG,EAAE,GAAG,OAAiB,EAAS,CAAC;QAC9C,IAAI,KAAK,CAAC,aAAa,EAAE;YACvB,MAAM,KAAK,GAAG,KAAwB,CAAC;YACvC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;gBACnB,KAAK,CAAC,QAAQ,GAAG,EAAE,CAAC;aACrB;YACD,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC;YAC5D,OAAO,KAAK,CAAC,aAAa,CAAC;SAC5B;QACD,MAAM,QAAQ,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;QAC7C,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACjC,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE;gBAClD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC;aACnB;QACH,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE;YAClB,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;SAC5B;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE;YAClB,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;SAC/B;QACD,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;YACnB,MAAM,GAAG,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACpC,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YACzB,KAAK,CAAC,QAAQ,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;SAChC;QAED,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE;YACf,IAAI,KAAK,CAAC,IAAI,EAAE;gBACd,KAAK,CAAC,IAAI,GAAG,OAAO,CAAC;aACtB;iBAAM;gBACL,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC;aACxB;SACF;aAAM,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,EAAE;YAClE,KAAK,CAAC,IAAI,GAAG,OAAO,CAAC;SACtB;QACD,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE;YAC1C,KAAK,CAAC,GAAG,GAAG,UAAU,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;SACjD;QAED,OAAO,UAAU,CAAC,sBAAsB,CAAC,KAA4C,CAAC,CAAC;IACzF,CAAC;IAED,MAAM,CAAC,iBAAiB,CAAC,OAA0B;QACjD,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;QAChC,MAAM,CAAC,GAAG,IAAI,IAAI,EAAE,CAAC;QACrB,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACvB,MAAM,IAAI,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;QACvC,OAAO,GAAG,IAAI,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;IACvC,CAAC;IAED,MAAM,CAAC,sBAAsB,CAAI,OAAU;QACzC,MAAM,KAAK,GAAG,OAAc,CAAC;QAC7B,MAAM,EAAE,IAAI,GAAG,EAAE,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC;QACtC,IAAI,CAAC,QAAQ,EAAE;YACb,OAAO,OAAO,CAAC;SAChB;QACD,MAAM,WAAW,GAA0B;YACzC,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,IAAI;YACX,IAAI,EAAE,QAAQ;SACf,CAAC;QACF,MAAM,IAAI,GAAG,EAAE,GAAG,KAAK,EAAE,CAAC;QAC1B,IAAI,CAAC,aAAa,GAAG,CAAC,WAAW,CAAC,CAAC;QACnC,OAAO,IAAI,CAAC,IAAI,CAAC;QACjB,OAAO,IAAI,CAAC,QAAQ,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,yBAAyB,CAAC,IAA8D;QAC7F,IAAI,CAAC,IAAI,EAAE;YACT,OAAO,IAAI,CAAC;SACb;QACD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC5B,OAAO,IAAI,CAAC;SACb;QACD,IAAI,SAAS,IAAI,IAAI,YAAY,MAAM,EAAE;YACvC,OAAO,IAAI,CAAC;SACb;QACD,IAAI,IAAI,YAAY,WAAW,EAAE;YAC/B,OAAO,IAAI,CAAC;SACb;QACD,MAAM,KAAK,GAAG,IAAgC,CAAC;QAC/C,IAAI,KAAK,CAAC,IAAI,KAAK,aAAa,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,SAAS,CAAC,EAAE;YAC3E,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC9C,OAAO,MAAM,CAAC;SACf;QACD,IAAI,SAAS,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;YACxC,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;SAChC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF"}

package/build/src/models/store/File.d.ts

@@ -204,6 +204,23 @@ export declare class StoredFile {
      * @param user The user key to compare.
      */
     static updateByMeMeta(file: IFile, user: string): void;
+    /**
+     * Static method to set the `lastModified` property on a file without creating an instance of a file meta.
+     * Useful when the meta kind is unknown.
+     *
+     * @param file The file to update. Note, this method mutates the file.
+     * @param user The user that modifies the file.
+     * @returns The same file.
+     */
+    static setLastModified(file: IFile, user: IUser): IFile;
+    /**
+     * Similar to the instance method `setDeleted()` but without creating an instance of the file when the type is unknown.
+     *
+     * @param file The file to change. Note, this operation mutates the file.
+     * @param user The deleting user
+     * @returns The same file reference.
+     */
+    static setDeleted(file: IFile, user: IUser): IFile;
 }
 export declare class File extends StoredFile {
     [permissionsSymbol]: ReadonlyArray<IPermission>;

package/build/src/models/store/File.js

@@ -207,7 +207,7 @@ export class StoredFile {
             throw new Error(`The user is required.`);
         }
         if (user.kind !== UserKind) {
-            throw new Error(`Invalid value for the user when setting "lastModified".`);
+            throw new Error(`Invalid value for the user when setting "deletedInfo".`);
         }
         this[deletedSymbol] = true;
         this[deletedInfoSymbol] = {
@@ -281,6 +281,58 @@ export class StoredFile {
             file.lastModified.byMe = file.lastModified.user === user;
         }
     }
+    /**
+     * Static method to set the `lastModified` property on a file without creating an instance of a file meta.
+     * Useful when the meta kind is unknown.
+     *
+     * @param file The file to update. Note, this method mutates the file.
+     * @param user The user that modifies the file.
+     * @returns The same file.
+     */
+    static setLastModified(file, user) {
+        if (!file) {
+            throw new Error(`The file is required.`);
+        }
+        if (!user) {
+            throw new Error(`The user is required.`);
+        }
+        if (user.kind !== UserKind) {
+            throw new Error(`Invalid value for the user when setting "lastModified".`);
+        }
+        file.lastModified = {
+            byMe: false,
+            time: Date.now(),
+            user: user.key,
+            name: user.name,
+        };
+        return file;
+    }
+    /**
+     * Similar to the instance method `setDeleted()` but without creating an instance of the file when the type is unknown.
+     *
+     * @param file The file to change. Note, this operation mutates the file.
+     * @param user The deleting user
+     * @returns The same file reference.
+     */
+    static setDeleted(file, user) {
+        if (!file) {
+            throw new Error(`The file is required.`);
+        }
+        if (!user) {
+            throw new Error(`The user is required.`);
+        }
+        if (user.kind !== UserKind) {
+            throw new Error(`Invalid value for the user when setting "deletedInfo".`);
+        }
+        file.deleted = true;
+        file.deletedInfo = {
+            byMe: false,
+            time: Date.now(),
+            user: user.key,
+            name: user.name,
+        };
+        return file;
+    }
 }
 export class File extends StoredFile {
     [permissionsSymbol] = [];