@api-client/core 0.3.0

package/build/src/models/ProjectSchema.d.ts

@@ -0,0 +1,105 @@
+import { Property, IProperty, PropertyType } from './Property.js';
+export declare const Kind = "ARC#ProjectSchema";
+export interface IProjectSchema {
+    kind?: 'ARC#ProjectSchema';
+    /**
+     * The identifier of the environment.
+     */
+    key: string;
+    /**
+     * The name of the schema.
+     */
+    name: string;
+    /**
+     * The optional list of properties in this schema.
+     * Because this is a list instead of a map it is possible to duplicate the property name. In this
+     * case the last set value is the final value.
+     *
+     * When both the `properties` and the `content` is defined, `content` is used instead of properties.
+     */
+    properties?: IProperty[];
+    /**
+     * The "raw" content of the schema.
+     * This value goes unchanged to the request.
+     */
+    content?: string;
+    /**
+     * When content is used, it informs about the content type of the
+     * schema. The schema is invalid when `content` is set and the `mime` is not.
+     */
+    mime?: string;
+}
+/**
+ * A project can contain schema definitions that can be reused in project requests.
+ * The schema consists of:
+ *
+ * - content: the "raw" schema value in any format. This goes unprocessed into the request body.
+ * - properties: a map of properties description that can be manipulated at runtime
+ *
+ * Scalar values are not supported as a schema definition. It always represents an object.
+ */
+export declare class ProjectSchema {
+    kind: string;
+    /**
+     * The identifier of the environment.
+     */
+    key: string;
+    /**
+     * The optional list of properties in this schema.
+     * Because this is a list instead of a map it is possible to duplicate the property name. In this
+     * case the last set value is the final value.
+     *
+     * When both the `properties` and the `content` is defined, `content` is used instead of properties.
+     */
+    properties?: Property[];
+    /**
+     * The "raw" content of the schema.
+     * This value goes unchanged to the request.
+     */
+    content?: string;
+    /**
+     * When content is used, it informs about the content type of the
+     * schema. The schema is invalid when `content` is set and the `mime` is not.
+     */
+    mime?: string;
+    /**
+     * The name of the schema.
+     */
+    name: string;
+    /**
+     * Creates a new schema instance from the passed name.
+     * @param name The name of the schema.
+     */
+    static fromName(name: string): ProjectSchema;
+    /**
+     * Creates a new schema instance from the content definition
+     * @param name The name of the schema.
+     * @param content The "raw" content of the schema
+     * @param mime The mime type associated with the schema.
+     * @returns The instance of the created schema
+     */
+    static fromContent(name: string, content: string, mime: string): ProjectSchema;
+    /**
+     * @param input The schema definition used to restore the state.
+     */
+    constructor(input?: string | IProjectSchema);
+    /**
+     * Creates a new schema definition clearing anything that is so far defined.
+     */
+    new(init: IProjectSchema): void;
+    toJSON(): IProjectSchema;
+    /**
+     * Creates a schema property from a definition.
+     * @param info The property definition.
+     * @returns The same property definition
+     */
+    addProperty(info: IProperty): Property;
+    /**
+     * Creates a schema property from a definition.
+     *
+     * @param name The property name
+     * @param type The property data type
+     * @returns The created schema definition.
+     */
+    addProperty(name: string, type: PropertyType): Property;
+}

package/build/src/models/ProjectSchema.js

@@ -0,0 +1,156 @@
+import v4 from '../lib/uuid.js';
+import { Property, Kind as PropertyKind } from './Property.js';
+export const Kind = 'ARC#ProjectSchema';
+/**
+ * A project can contain schema definitions that can be reused in project requests.
+ * The schema consists of:
+ *
+ * - content: the "raw" schema value in any format. This goes unprocessed into the request body.
+ * - properties: a map of properties description that can be manipulated at runtime
+ *
+ * Scalar values are not supported as a schema definition. It always represents an object.
+ */
+export class ProjectSchema {
+    kind = Kind;
+    /**
+     * The identifier of the environment.
+     */
+    key = '';
+    /**
+     * The optional list of properties in this schema.
+     * Because this is a list instead of a map it is possible to duplicate the property name. In this
+     * case the last set value is the final value.
+     *
+     * When both the `properties` and the `content` is defined, `content` is used instead of properties.
+     */
+    properties;
+    /**
+     * The "raw" content of the schema.
+     * This value goes unchanged to the request.
+     */
+    content;
+    /**
+     * When content is used, it informs about the content type of the
+     * schema. The schema is invalid when `content` is set and the `mime` is not.
+     */
+    mime;
+    /**
+     * The name of the schema.
+     */
+    name = '';
+    /**
+     * Creates a new schema instance from the passed name.
+     * @param name The name of the schema.
+     */
+    static fromName(name) {
+        const init = {
+            kind: Kind,
+            name,
+            key: v4(),
+        };
+        return new ProjectSchema(init);
+    }
+    /**
+     * Creates a new schema instance from the content definition
+     * @param name The name of the schema.
+     * @param content The "raw" content of the schema
+     * @param mime The mime type associated with the schema.
+     * @returns The instance of the created schema
+     */
+    static fromContent(name, content, mime) {
+        const init = {
+            kind: Kind,
+            name,
+            key: v4(),
+            content,
+            mime,
+        };
+        return new ProjectSchema(init);
+    }
+    /**
+     * @param input The schema definition used to restore the state.
+     */
+    constructor(input) {
+        let init;
+        if (typeof input === 'string') {
+            init = JSON.parse(input);
+        }
+        else if (typeof input === 'object') {
+            init = input;
+        }
+        else {
+            init = {
+                kind: Kind,
+                name: '',
+                key: v4(),
+            };
+        }
+        this.new(init);
+    }
+    /**
+     * Creates a new schema definition clearing anything that is so far defined.
+     */
+    new(init) {
+        const { key = v4(), content, properties, mime, name = '' } = init;
+        this.name = name;
+        this.key = key;
+        if (content) {
+            this.content = content;
+        }
+        else {
+            this.content = undefined;
+        }
+        if (Array.isArray(properties)) {
+            this.properties = properties.map(i => new Property(i));
+        }
+        else {
+            this.properties = undefined;
+        }
+        if (mime) {
+            this.mime = mime;
+        }
+        else {
+            this.mime = undefined;
+        }
+    }
+    toJSON() {
+        const result = {
+            kind: Kind,
+            name: this.name || '',
+            key: this.key || v4(),
+        };
+        if (this.content) {
+            result.content = this.content;
+        }
+        if (this.mime) {
+            result.mime = this.mime;
+        }
+        if (Array.isArray(this.properties) && this.properties.length) {
+            result.properties = this.properties.map(i => i.toJSON());
+        }
+        return result;
+    }
+    addProperty(infoOrName, type) {
+        const infoType = typeof infoOrName;
+        if (infoType === 'string' && !type) {
+            throw new Error('The type is required.');
+        }
+        let instance;
+        if (infoType === 'string') {
+            instance = Property.fromTypeDefault(infoOrName, type);
+        }
+        else {
+            const init = infoOrName;
+            if (!init.kind) {
+                init.kind = PropertyKind;
+            }
+            instance = new Property(init);
+        }
+        if (!Array.isArray(this.properties)) {
+            this.properties = [];
+        }
+        this.properties.push(instance);
+        return instance;
+    }
+}
+//# sourceMappingURL=ProjectSchema.js.map

package/build/src/models/ProjectSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProjectSchema.js","sourceRoot":"","sources":["../../../src/models/ProjectSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAChC,OAAO,EAAE,QAAQ,EAA2B,IAAI,IAAI,YAAY,EAAE,MAAM,eAAe,CAAC;AACxF,MAAM,CAAC,MAAM,IAAI,GAAG,mBAAmB,CAAC;AAgCxC;;;;;;;;GAQG;AACH,MAAM,OAAO,aAAa;IACxB,IAAI,GAAG,IAAI,CAAC;IACZ;;OAEG;IACH,GAAG,GAAG,EAAE,CAAC;IACT;;;;;;OAMG;IACH,UAAU,CAAc;IACxB;;;OAGG;IACH,OAAO,CAAU;IACjB;;;OAGG;IACH,IAAI,CAAU;IACd;;OAEG;IACH,IAAI,GAAE,EAAE,CAAC;IAET;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAY;QAC1B,MAAM,IAAI,GAAmB;YAC3B,IAAI,EAAE,IAAI;YACV,IAAI;YACJ,GAAG,EAAE,EAAE,EAAE;SACV,CAAC;QACF,OAAO,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,WAAW,CAAC,IAAY,EAAE,OAAe,EAAE,IAAY;QAC5D,MAAM,IAAI,GAAmB;YAC3B,IAAI,EAAE,IAAI;YACV,IAAI;YACJ,GAAG,EAAE,EAAE,EAAE;YACT,OAAO;YACP,IAAI;SACL,CAAC;QACF,OAAO,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,YAAY,KAA+B;QACzC,IAAI,IAAoB,CAAC;QACzB,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,IAAI,EAAE,EAAE;gBACR,GAAG,EAAE,EAAE,EAAE;aACV,CAAA;SACF;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,IAAoB;QACtB,MAAM,EAAE,GAAG,GAAC,EAAE,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,GAAC,EAAE,EAAE,GAAG,IAAI,CAAC;QAC9D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;SACxB;aAAM;YACL,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;SAC1B;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAC7B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;SACxD;aAAM;YACL,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;SAC7B;QACD,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;SAClB;aAAM;YACL,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;SACvB;IACH,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAkB;YAC5B,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE;YACrB,GAAG,EAAE,IAAI,CAAC,GAAG,IAAI,EAAE,EAAE;SACtB,CAAC;QACF,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;SAC/B;QACD,IAAI,IAAI,CAAC,IAAI,EAAE;YACb,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;SACzB;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE;YAC5D,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;SAC1D;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAkBD,WAAW,CAAC,UAA8B,EAAE,IAAmB;QAC7D,MAAM,QAAQ,GAAG,OAAO,UAAU,CAAC;QACnC,IAAI,QAAQ,KAAK,QAAQ,IAAI,CAAC,IAAI,EAAE;YAClC,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;SAC1C;QACD,IAAI,QAAkB,CAAC;QACvB,IAAI,QAAQ,KAAK,QAAQ,EAAE;YACzB,QAAQ,GAAG,QAAQ,CAAC,eAAe,CAAC,UAAoB,EAAE,IAAoB,CAAC,CAAC;SACjF;aAAM;YACL,MAAM,IAAI,GAAG,UAAuB,CAAC;YACrC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;gBACd,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC;aAC1B;YACD,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC;SAC/B;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YACnC,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;SACtB;QACD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC/B,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}

package/build/src/models/Property.d.ts

@@ -0,0 +1,130 @@
+import { ApiType } from './legacy/models/ApiTypes.js';
+export declare type PropertyType = 'string' | 'integer' | 'float' | 'nil' | 'boolean' | 'date' | 'datetime' | 'time' | 'int32' | 'int64' | 'uint32' | 'uint64' | 'sint32' | 'sint64' | 'fixed32' | 'fixed64' | 'sfixed32' | 'sfixed64' | 'double' | 'bytes';
+export interface IProperty {
+    kind: 'ARC#Property';
+    /**
+     * Property name
+     */
+    name: string;
+    /**
+     * Property value
+     */
+    value: unknown | IProperty[];
+    /**
+     * Property data type
+     */
+    type: PropertyType;
+    /**
+     * Whether the property is enabled. If not set it is assumed the property is enabled.
+     */
+    enabled?: boolean;
+    /**
+     * The default value for the property
+     */
+    default?: unknown;
+    /**
+     * Enum values for the property.
+     */
+    enum?: unknown;
+    /**
+     * The description of the property
+     */
+    description?: string;
+    /**
+     * Whether the value id required to be provided. This is used with validation.
+     */
+    required?: boolean;
+    /**
+     * When set to `true` it represents a property that is an array.
+     */
+    repeated?: boolean;
+}
+export declare const Kind = "ARC#Property";
+/**
+ * A property of an HTTP request.
+ */
+export declare class Property {
+    kind: string;
+    /**
+     * Property name
+     */
+    name: string;
+    /**
+     * Property data type
+     */
+    type: PropertyType;
+    /**
+     * Property value
+     */
+    value: unknown;
+    /**
+     * The description of the property
+     */
+    description?: string;
+    /**
+     * The default value for the property
+     */
+    default?: unknown;
+    /**
+     * Whether the property is enabled. If not set it is assumed the property is enabled.
+     */
+    enabled?: boolean;
+    /**
+     * Enum values for the property.
+     */
+    enum?: unknown;
+    /**
+     * Whether the value id required to be provided. This is used with validation.
+     */
+    required?: boolean;
+    /**
+     * When set to `true` it represents a property that is an array.
+     */
+    repeated?: boolean;
+    static get supportedTypes(): PropertyType[];
+    /**
+     * Creates an instance of a property recognizing the type of the `value`.
+     * It only works for primitive values.
+     *
+     * @param name The name of the property
+     * @param value The value of the property. Default to an empty string which is the same as calling `Property.String()`.
+     * @param enabled Whether the property is enabled.
+     */
+    static fromType(name?: string, value?: unknown, enabled?: boolean): Property;
+    static fromTypeDefault(name: string | undefined, type: PropertyType): Property;
+    static String(name?: string, value?: string, enabled?: boolean): Property;
+    static Integer(name?: string, value?: number, enabled?: boolean): Property;
+    static Int32(name?: string, value?: number, enabled?: boolean): Property;
+    static Int64(name?: string, value?: number, enabled?: boolean): Property;
+    static Uint32(name?: string, value?: number, enabled?: boolean): Property;
+    static Uint64(name?: string, value?: number, enabled?: boolean): Property;
+    static Sint32(name?: string, value?: number, enabled?: boolean): Property;
+    static Sint64(name?: string, value?: number, enabled?: boolean): Property;
+    static Fixed32(name?: string, value?: number, enabled?: boolean): Property;
+    static Fixed64(name?: string, value?: number, enabled?: boolean): Property;
+    static Sfixed32(name?: string, value?: number, enabled?: boolean): Property;
+    static Sfixed64(name?: string, value?: number, enabled?: boolean): Property;
+    static Float(name?: string, value?: number, enabled?: boolean): Property;
+    static Double(name?: string, value?: number, enabled?: boolean): Property;
+    static Boolean(name?: string, value?: boolean, enabled?: boolean): Property;
+    static Date(name?: string): Property;
+    static Datetime(name?: string): Property;
+    static Time(name?: string): Property;
+    static Bytes(name?: string): Property;
+    static fromApiType(type: ApiType): Property;
+    /**
+     * @param input The property definition used to restore the state.
+     */
+    constructor(input?: string | IProperty);
+    /**
+     * Creates a new environment clearing anything that is so far defined.
+     *
+     * Note, this throws an error when the property is not an ARC environment.
+     */
+    new(init: IProperty): void;
+    /**
+     * Checks whether the input is a definition of a property.
+     */
+    static isProperty(input: unknown): boolean;
+    toJSON(): IProperty;
+}