@webiny/api 0.0.0-unstable.1e66d121db

package/Context.d.ts

@@ -0,0 +1,19 @@
+import { Context as ContextInterface } from "./types";
+import { PluginsContainer } from "@webiny/plugins";
+import { PluginCollection } from "@webiny/plugins/types";
+export interface ContextParams {
+    plugins?: PluginCollection;
+    WEBINY_VERSION: string;
+}
+export declare class Context implements ContextInterface {
+    _result: any;
+    args: any;
+    readonly plugins: PluginsContainer;
+    readonly WEBINY_VERSION: string;
+    private readonly waiters;
+    constructor(params: ContextParams);
+    getResult(): any;
+    hasResult(): boolean;
+    setResult(value: any): void;
+    waitFor<T extends ContextInterface = ContextInterface>(obj: string | string[], cb: (context: T) => void): void;
+}

package/Context.js

@@ -0,0 +1,149 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Context = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _plugins = require("@webiny/plugins");
+
+class Context {
+  constructor(params) {
+    (0, _defineProperty2.default)(this, "_result", void 0);
+    (0, _defineProperty2.default)(this, "args", void 0);
+    (0, _defineProperty2.default)(this, "plugins", void 0);
+    (0, _defineProperty2.default)(this, "WEBINY_VERSION", void 0);
+    (0, _defineProperty2.default)(this, "waiters", []);
+    const {
+      plugins,
+      WEBINY_VERSION
+    } = params;
+    this.plugins = new _plugins.PluginsContainer(plugins || []);
+    this.WEBINY_VERSION = WEBINY_VERSION;
+  }
+
+  getResult() {
+    return this._result;
+  }
+
+  hasResult() {
+    return !!this._result;
+  }
+
+  setResult(value) {
+    this._result = value;
+  }
+
+  waitFor(obj, cb) {
+    const initialTargets = Array.isArray(obj) ? obj : [obj];
+    const targets = [];
+    /**
+     * We go only through the first level properties
+     */
+
+    for (const key in initialTargets) {
+      const target = initialTargets[key];
+      /**
+       * If property already exists, there is no need to wait for it, so we just continue the loop.
+       * Also, if target is not a string, skip this property as it will fail to convert properly during the runtime.
+       */
+
+      if (this[target]) {
+        continue;
+      } else if (typeof target !== "string") {
+        continue;
+      }
+      /**
+       * Since there is no property, we must define it with its setter and getter.
+       * We could not know when it got defined otherwise.
+       */
+
+
+      Object.defineProperty(this, target, {
+        /**
+         * Setter sets the given value to this object.
+         * We cannot set it on exact property name it is defined because it would go into loop of setting itself.
+         * And that is why we add __ around the property name.
+         */
+        set: value => {
+          const newTargetKey = `__${target}__`;
+          this[newTargetKey] = value;
+          /**
+           * WWhen the property is set, we will go through all the waiters and, if any of them include currently set property, act on it.
+           */
+
+          for (const waiter of this.waiters) {
+            if (waiter.targets.includes(target) === false) {
+              continue;
+            }
+            /**
+             * Remove currently set property so we know if there are any more to be waited for.
+             */
+
+
+            waiter.targets = waiter.targets.filter(t => t !== target);
+            /**
+             * If there are more to be waited, eg. user added [cms, pageBuilder] as waited properties, we just continue the loop.
+             */
+
+            if (waiter.targets.length > 0) {
+              continue;
+            }
+            /**
+             * And if there is nothing more to be waited for, we execute the callable.
+             * Note that this callable is not async.
+             */
+
+
+            waiter.cb(this);
+          }
+        },
+
+        /**
+         * As we have set property with __ around it, we must get it as well.
+         */
+        get: () => {
+          const newTargetKey = `__${target}__`;
+          return this[newTargetKey];
+        },
+        configurable: false
+      });
+      /**
+       * We add the target to be awaited.
+       */
+
+      targets.push(target);
+    }
+    /**
+     * If there are no targets to be awaited, just fire the callable.
+     */
+
+
+    if (targets.length === 0) {
+      cb(this);
+      return;
+    }
+    /**
+     * Otherwise add the waiter for the target properties.
+     */
+
+
+    this.waiters.push({
+      targets,
+
+      /**
+       * TODO @ts-refactor
+       * Problem with possible subtype initialization
+       */
+      // @ts-ignore
+      cb
+    });
+  }
+
+}
+
+exports.Context = Context;

package/Context.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["Context","constructor","params","plugins","WEBINY_VERSION","PluginsContainer","getResult","_result","hasResult","setResult","value","waitFor","obj","cb","initialTargets","Array","isArray","targets","key","target","Object","defineProperty","set","newTargetKey","waiter","waiters","includes","filter","t","length","get","configurable","push"],"sources":["Context.ts"],"sourcesContent":["import { Context as ContextInterface } from \"~/types\";\nimport { PluginsContainer } from \"@webiny/plugins\";\nimport { PluginCollection } from \"@webiny/plugins/types\";\n\ninterface Waiter {\n    targets: string[];\n    cb: (context: ContextInterface) => void;\n}\n\nexport interface ContextParams {\n    plugins?: PluginCollection;\n    WEBINY_VERSION: string;\n}\nexport class Context implements ContextInterface {\n    public _result: any;\n    public args: any;\n    public readonly plugins: PluginsContainer;\n    public readonly WEBINY_VERSION: string;\n\n    private readonly waiters: Waiter[] = [];\n\n    public constructor(params: ContextParams) {\n        const { plugins, WEBINY_VERSION } = params;\n        this.plugins = new PluginsContainer(plugins || []);\n        this.WEBINY_VERSION = WEBINY_VERSION;\n    }\n\n    public getResult(): any {\n        return this._result;\n    }\n\n    public hasResult(): boolean {\n        return !!this._result;\n    }\n\n    public setResult(value: any): void {\n        this._result = value;\n    }\n\n    public waitFor<T extends ContextInterface = ContextInterface>(\n        obj: string | string[],\n        cb: (context: T) => void\n    ): void {\n        const initialTargets = Array.isArray(obj) ? obj : [obj];\n        const targets: string[] = [];\n        /**\n         * We go only through the first level properties\n         */\n        for (const key in initialTargets) {\n            const target = initialTargets[key] as keyof this;\n            /**\n             * If property already exists, there is no need to wait for it, so we just continue the loop.\n             * Also, if target is not a string, skip this property as it will fail to convert properly during the runtime.\n             */\n            if (this[target]) {\n                continue;\n            } else if (typeof target !== \"string\") {\n                continue;\n            }\n            /**\n             * Since there is no property, we must define it with its setter and getter.\n             * We could not know when it got defined otherwise.\n             */\n            Object.defineProperty(this, target, {\n                /**\n                 * Setter sets the given value to this object.\n                 * We cannot set it on exact property name it is defined because it would go into loop of setting itself.\n                 * And that is why we add __ around the property name.\n                 */\n                set: (value: any) => {\n                    const newTargetKey = `__${target}__` as keyof this;\n                    this[newTargetKey] = value;\n                    /**\n                     * WWhen the property is set, we will go through all the waiters and, if any of them include currently set property, act on it.\n                     */\n                    for (const waiter of this.waiters) {\n                        if (waiter.targets.includes(target) === false) {\n                            continue;\n                        }\n                        /**\n                         * Remove currently set property so we know if there are any more to be waited for.\n                         */\n                        waiter.targets = waiter.targets.filter(t => t !== target);\n                        /**\n                         * If there are more to be waited, eg. user added [cms, pageBuilder] as waited properties, we just continue the loop.\n                         */\n                        if (waiter.targets.length > 0) {\n                            continue;\n                        }\n                        /**\n                         * And if there is nothing more to be waited for, we execute the callable.\n                         * Note that this callable is not async.\n                         */\n                        waiter.cb(this);\n                    }\n                },\n                /**\n                 * As we have set property with __ around it, we must get it as well.\n                 */\n                get: (): any => {\n                    const newTargetKey = `__${target}__` as keyof this;\n                    return this[newTargetKey];\n                },\n                configurable: false\n            });\n            /**\n             * We add the target to be awaited.\n             */\n            targets.push(target as string);\n        }\n        /**\n         * If there are no targets to be awaited, just fire the callable.\n         */\n        if (targets.length === 0) {\n            cb(this as any);\n            return;\n        }\n        /**\n         * Otherwise add the waiter for the target properties.\n         */\n        this.waiters.push({\n            targets,\n            /**\n             * TODO @ts-refactor\n             * Problem with possible subtype initialization\n             */\n            // @ts-ignore\n            cb\n        });\n    }\n}\n"],"mappings":";;;;;;;;;;;AACA;;AAYO,MAAMA,OAAN,CAA0C;EAQtCC,WAAW,CAACC,MAAD,EAAwB;IAAA;IAAA;IAAA;IAAA;IAAA,+CAFL,EAEK;IACtC,MAAM;MAAEC,OAAF;MAAWC;IAAX,IAA8BF,MAApC;IACA,KAAKC,OAAL,GAAe,IAAIE,yBAAJ,CAAqBF,OAAO,IAAI,EAAhC,CAAf;IACA,KAAKC,cAAL,GAAsBA,cAAtB;EACH;;EAEME,SAAS,GAAQ;IACpB,OAAO,KAAKC,OAAZ;EACH;;EAEMC,SAAS,GAAY;IACxB,OAAO,CAAC,CAAC,KAAKD,OAAd;EACH;;EAEME,SAAS,CAACC,KAAD,EAAmB;IAC/B,KAAKH,OAAL,GAAeG,KAAf;EACH;;EAEMC,OAAO,CACVC,GADU,EAEVC,EAFU,EAGN;IACJ,MAAMC,cAAc,GAAGC,KAAK,CAACC,OAAN,CAAcJ,GAAd,IAAqBA,GAArB,GAA2B,CAACA,GAAD,CAAlD;IACA,MAAMK,OAAiB,GAAG,EAA1B;IACA;AACR;AACA;;IACQ,KAAK,MAAMC,GAAX,IAAkBJ,cAAlB,EAAkC;MAC9B,MAAMK,MAAM,GAAGL,cAAc,CAACI,GAAD,CAA7B;MACA;AACZ;AACA;AACA;;MACY,IAAI,KAAKC,MAAL,CAAJ,EAAkB;QACd;MACH,CAFD,MAEO,IAAI,OAAOA,MAAP,KAAkB,QAAtB,EAAgC;QACnC;MACH;MACD;AACZ;AACA;AACA;;;MACYC,MAAM,CAACC,cAAP,CAAsB,IAAtB,EAA4BF,MAA5B,EAAoC;QAChC;AAChB;AACA;AACA;AACA;QACgBG,GAAG,EAAGZ,KAAD,IAAgB;UACjB,MAAMa,YAAY,GAAI,KAAIJ,MAAO,IAAjC;UACA,KAAKI,YAAL,IAAqBb,KAArB;UACA;AACpB;AACA;;UACoB,KAAK,MAAMc,MAAX,IAAqB,KAAKC,OAA1B,EAAmC;YAC/B,IAAID,MAAM,CAACP,OAAP,CAAeS,QAAf,CAAwBP,MAAxB,MAAoC,KAAxC,EAA+C;cAC3C;YACH;YACD;AACxB;AACA;;;YACwBK,MAAM,CAACP,OAAP,GAAiBO,MAAM,CAACP,OAAP,CAAeU,MAAf,CAAsBC,CAAC,IAAIA,CAAC,KAAKT,MAAjC,CAAjB;YACA;AACxB;AACA;;YACwB,IAAIK,MAAM,CAACP,OAAP,CAAeY,MAAf,GAAwB,CAA5B,EAA+B;cAC3B;YACH;YACD;AACxB;AACA;AACA;;;YACwBL,MAAM,CAACX,EAAP,CAAU,IAAV;UACH;QACJ,CAhC+B;;QAiChC;AAChB;AACA;QACgBiB,GAAG,EAAE,MAAW;UACZ,MAAMP,YAAY,GAAI,KAAIJ,MAAO,IAAjC;UACA,OAAO,KAAKI,YAAL,CAAP;QACH,CAvC+B;QAwChCQ,YAAY,EAAE;MAxCkB,CAApC;MA0CA;AACZ;AACA;;MACYd,OAAO,CAACe,IAAR,CAAab,MAAb;IACH;IACD;AACR;AACA;;;IACQ,IAAIF,OAAO,CAACY,MAAR,KAAmB,CAAvB,EAA0B;MACtBhB,EAAE,CAAC,IAAD,CAAF;MACA;IACH;IACD;AACR;AACA;;;IACQ,KAAKY,OAAL,CAAaO,IAAb,CAAkB;MACdf,OADc;;MAEd;AACZ;AACA;AACA;MACY;MACAJ;IAPc,CAAlB;EASH;;AApH4C"}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Webiny
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,15 @@
+# @webiny/api
+[![](https://img.shields.io/npm/dw/@webiny/api.svg)](https://www.npmjs.com/package/@webiny/api) 
+[![](https://img.shields.io/npm/v/@webiny/api.svg)](https://www.npmjs.com/package/@webiny/api)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
+
+## Install
+```
+npm install --save @webiny/api
+```
+
+Or if you prefer yarn: 
+```
+yarn add @webiny/api
+```

package/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./Context";
+export * from "./plugins/ContextPlugin";

package/index.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+var _Context = require("./Context");
+
+Object.keys(_Context).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _Context[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _Context[key];
+    }
+  });
+});
+
+var _ContextPlugin = require("./plugins/ContextPlugin");
+
+Object.keys(_ContextPlugin).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _ContextPlugin[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _ContextPlugin[key];
+    }
+  });
+});

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["index.ts"],"sourcesContent":["export * from \"~/Context\";\nexport * from \"~/plugins/ContextPlugin\";\n"],"mappings":";;;;;;AAAA;;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;;AACA;;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA"}

package/package.json

@@ -0,0 +1,38 @@
+{
+	"name": "@webiny/api",
+	"version": "0.0.0-unstable.1e66d121db",
+	"main": "index.js",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/webiny/webiny-js.git"
+	},
+	"description": "Core package for all of our API packages.",
+	"contributors": [
+		"Bruno Zorić <bruno@webiny.com>"
+	],
+	"license": "MIT",
+	"dependencies": {
+		"@babel/runtime": "7.19.0",
+		"@webiny/plugins": "0.0.0-unstable.1e66d121db"
+	},
+	"devDependencies": {
+		"@babel/cli": "^7.19.3",
+		"@babel/core": "^7.19.3",
+		"@babel/preset-env": "^7.19.4",
+		"@babel/preset-typescript": "^7.18.6",
+		"@webiny/cli": "^0.0.0-unstable.1e66d121db",
+		"@webiny/project-utils": "^0.0.0-unstable.1e66d121db",
+		"rimraf": "^3.0.2",
+		"ttypescript": "^1.5.13",
+		"typescript": "4.7.4"
+	},
+	"publishConfig": {
+		"access": "public",
+		"directory": "dist"
+	},
+	"scripts": {
+		"build": "yarn webiny run build",
+		"watch": "yarn webiny run watch"
+	},
+	"gitHead": "b670bf27c5039de1a2b0be764a09ba4cb94ad5e2"
+}

package/plugins/ContextPlugin.d.ts

@@ -0,0 +1,12 @@
+import { Plugin } from "@webiny/plugins";
+import { Context } from "../types";
+export interface ContextPluginCallable<T extends Context = Context> {
+    (context: T): void | Promise<void>;
+}
+export declare class ContextPlugin<T extends Context = Context> extends Plugin {
+    static readonly type: string;
+    private readonly _callable;
+    constructor(callable: ContextPluginCallable<T>);
+    apply(context: T): Promise<void>;
+}
+export declare const createContextPlugin: <T extends Context = Context>(callable: ContextPluginCallable<T>) => ContextPlugin<T>;

package/plugins/ContextPlugin.js

@@ -0,0 +1,38 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createContextPlugin = exports.ContextPlugin = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _plugins = require("@webiny/plugins");
+
+class ContextPlugin extends _plugins.Plugin {
+  constructor(callable) {
+    super();
+    (0, _defineProperty2.default)(this, "_callable", void 0);
+    this._callable = callable;
+  }
+
+  async apply(context) {
+    if (typeof this._callable !== "function") {
+      throw Error(`Missing callable in ContextPlugin! Either pass a callable to plugin constructor or extend the plugin and override the "apply" method.`);
+    }
+
+    return this._callable(context);
+  }
+
+}
+
+exports.ContextPlugin = ContextPlugin;
+(0, _defineProperty2.default)(ContextPlugin, "type", "context");
+
+const createContextPlugin = callable => {
+  return new ContextPlugin(callable);
+};
+
+exports.createContextPlugin = createContextPlugin;

package/plugins/ContextPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["ContextPlugin","Plugin","constructor","callable","_callable","apply","context","Error","createContextPlugin"],"sources":["ContextPlugin.ts"],"sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport { Context } from \"~/types\";\n\nexport interface ContextPluginCallable<T extends Context = Context> {\n    (context: T): void | Promise<void>;\n}\n\nexport class ContextPlugin<T extends Context = Context> extends Plugin {\n    public static override readonly type: string = \"context\";\n    private readonly _callable: ContextPluginCallable<T>;\n\n    constructor(callable: ContextPluginCallable<T>) {\n        super();\n        this._callable = callable;\n    }\n\n    public async apply(context: T): Promise<void> {\n        if (typeof this._callable !== \"function\") {\n            throw Error(\n                `Missing callable in ContextPlugin! Either pass a callable to plugin constructor or extend the plugin and override the \"apply\" method.`\n            );\n        }\n\n        return this._callable(context);\n    }\n}\n\nexport const createContextPlugin = <T extends Context = Context>(\n    callable: ContextPluginCallable<T>\n): ContextPlugin<T> => {\n    return new ContextPlugin<T>(callable);\n};\n"],"mappings":";;;;;;;;;;;AAAA;;AAOO,MAAMA,aAAN,SAAyDC,eAAzD,CAAgE;EAInEC,WAAW,CAACC,QAAD,EAAqC;IAC5C;IAD4C;IAE5C,KAAKC,SAAL,GAAiBD,QAAjB;EACH;;EAEiB,MAALE,KAAK,CAACC,OAAD,EAA4B;IAC1C,IAAI,OAAO,KAAKF,SAAZ,KAA0B,UAA9B,EAA0C;MACtC,MAAMG,KAAK,CACN,uIADM,CAAX;IAGH;;IAED,OAAO,KAAKH,SAAL,CAAeE,OAAf,CAAP;EACH;;AAjBkE;;;8BAA1DN,a,UACsC,S;;AAmB5C,MAAMQ,mBAAmB,GAC5BL,QAD+B,IAEZ;EACnB,OAAO,IAAIH,aAAJ,CAAqBG,QAArB,CAAP;AACH,CAJM"}

package/types.d.ts

@@ -0,0 +1,37 @@
+import { PluginsContainer } from "@webiny/plugins";
+/**
+ * The main context which is constructed on every request.
+ * All other contexts should extend or augment this one.
+ */
+export interface Context {
+    plugins: PluginsContainer;
+    args: any;
+    readonly WEBINY_VERSION: string;
+    /**
+     * Not to be used outside of Webiny internal code.
+     * @internal
+     */
+    hasResult: () => boolean;
+    /**
+     * Not to be used outside of Webiny internal code.
+     * @internal
+     *
+     * @private
+     */
+    _result?: any;
+    /**
+     * Not to be used outside of Webiny internal code.
+     * @internal
+     */
+    setResult: (value: any) => void;
+    /**
+     * Not to be used outside of Webiny internal code.
+     * @internal
+     */
+    getResult: () => void;
+    /**
+     * Wait for property to be defined on the object and then execute the callable.
+     * In case of multiple objects defined, wait for all of them.
+     */
+    waitFor: <T extends Context = Context>(obj: string[] | string, cb: (context: T) => void) => void;
+}

package/types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/types.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import { PluginsContainer } from \"@webiny/plugins\";\n\n/**\n * The main context which is constructed on every request.\n * All other contexts should extend or augment this one.\n */\nexport interface Context {\n    plugins: PluginsContainer;\n    args: any;\n    readonly WEBINY_VERSION: string;\n    /**\n     * Not to be used outside of Webiny internal code.\n     * @internal\n     */\n    hasResult: () => boolean;\n    /**\n     * Not to be used outside of Webiny internal code.\n     * @internal\n     *\n     * @private\n     */\n    _result?: any;\n    /**\n     * Not to be used outside of Webiny internal code.\n     * @internal\n     */\n    setResult: (value: any) => void;\n    /**\n     * Not to be used outside of Webiny internal code.\n     * @internal\n     */\n    getResult: () => void;\n    /**\n     * Wait for property to be defined on the object and then execute the callable.\n     * In case of multiple objects defined, wait for all of them.\n     */\n    waitFor: <T extends Context = Context>(\n        obj: string[] | string,\n        cb: (context: T) => void\n    ) => void;\n}\n"],"mappings":""}