@wix/web-methods 0.1.0 → 0.1.2

package/cjs/build/index.d.ts

@@ -0,0 +1,2 @@
+export { webMethod } from './web-method.js';
+export { Permissions } from './permissions.js';

package/cjs/build/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Permissions = exports.webMethod = void 0;
+var web_method_js_1 = require("./web-method.js");
+Object.defineProperty(exports, "webMethod", { enumerable: true, get: function () { return web_method_js_1.webMethod; } });
+var permissions_js_1 = require("./permissions.js");
+Object.defineProperty(exports, "Permissions", { enumerable: true, get: function () { return permissions_js_1.Permissions; } });

package/cjs/build/permissions.d.ts

@@ -0,0 +1,21 @@
+export declare enum Roles {
+    SITE_OWNER = "siteOwner",
+    SITE_MEMBER = "siteMember",
+    ANONYMOUS = "anonymous"
+}
+export interface Permission {
+    allowedRoles: Roles[];
+}
+export declare const WEB_METHOD_OPTIONS_PROPERTY_NAME = "options";
+export declare const WEB_METHOD_PERMISSIONS_PROPERTY_NAME = "permission";
+export declare const Permissions: {
+    Admin: {
+        allowedRoles: Roles.SITE_OWNER[];
+    };
+    SiteMember: {
+        allowedRoles: (Roles.SITE_OWNER | Roles.SITE_MEMBER)[];
+    };
+    Anyone: {
+        allowedRoles: Roles[];
+    };
+};

package/cjs/build/permissions.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Permissions = exports.WEB_METHOD_PERMISSIONS_PROPERTY_NAME = exports.WEB_METHOD_OPTIONS_PROPERTY_NAME = exports.Roles = void 0;
+var Roles;
+(function (Roles) {
+    Roles["SITE_OWNER"] = "siteOwner";
+    Roles["SITE_MEMBER"] = "siteMember";
+    Roles["ANONYMOUS"] = "anonymous";
+})(Roles || (exports.Roles = Roles = {}));
+var PermissionOptions;
+(function (PermissionOptions) {
+    PermissionOptions["Admin"] = "Admin";
+    PermissionOptions["SiteMember"] = "SiteMember";
+    PermissionOptions["Anyone"] = "Anyone";
+})(PermissionOptions || (PermissionOptions = {}));
+const { SITE_OWNER, SITE_MEMBER, ANONYMOUS } = Roles;
+exports.WEB_METHOD_OPTIONS_PROPERTY_NAME = 'options';
+exports.WEB_METHOD_PERMISSIONS_PROPERTY_NAME = 'permission';
+exports.Permissions = {
+    Admin: { allowedRoles: [SITE_OWNER] },
+    SiteMember: { allowedRoles: [SITE_OWNER, SITE_MEMBER] },
+    Anyone: { allowedRoles: [SITE_OWNER, SITE_MEMBER, ANONYMOUS] },
+};

package/cjs/build/types.d.ts

@@ -0,0 +1,8 @@
+export type Handler<Args extends unknown[], Return> = (...args: Args) => Return;
+export interface CacheOptions {
+    tags: string[];
+    ttl?: number;
+}
+export interface WebMethodOptions {
+    cache?: CacheOptions;
+}

package/cjs/build/types.js

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

package/cjs/build/web-method.d.ts

@@ -0,0 +1,3 @@
+import { Permission } from './permissions.js';
+import { Handler, WebMethodOptions } from './types.js';
+export declare function webMethod<Args extends any[], Return>(permission: Permission, method: Handler<Args, Return>, options?: WebMethodOptions): Handler<Args, Promise<Awaited<Return>>>;

package/cjs/build/web-method.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.webMethod = webMethod;
+const permissions_js_1 = require("./permissions.js");
+// https://dev.wix.com/docs/velo/api-reference/wix-web-module/introduction
+function webMethod(permission, method, options) {
+    const webMethodEnrichment = {
+        [permissions_js_1.WEB_METHOD_PERMISSIONS_PROPERTY_NAME]: permission,
+        ...(options && { [permissions_js_1.WEB_METHOD_OPTIONS_PROPERTY_NAME]: options }),
+    };
+    const enrichedWebMethod = Object.assign(method, webMethodEnrichment);
+    // the return type of `webMethod` doesn't match its return type so that
+    // developers who call this would get the correct types
+    return enrichedWebMethod;
+}

package/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/package.json

@@ -1,21 +1,26 @@
 {
   "name": "@wix/web-methods",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "type": "module",
+  "main": "cjs/build/index.js",
   "exports": {
-    ".": "./build/index.js",
+    ".": {
+      "import": "./build/index.js",
+      "require": "./cjs/build/index.js"
+    },
     "./package.json": "./package.json"
   },
   "sideEffects": false,
   "files": [
-    "build"
+    "build",
+    "cjs"
   ],
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
   "scripts": {
-    "build": "tsc",
+    "build": "tsc && tsc --project tsconfig.cjs.json",
     "test": ":",
     "lint": "eslint --max-warnings=0 .",
     "lint:fix": "eslint --max-warnings=0 . --fix",
@@ -46,5 +51,5 @@
       ]
     }
   },
-  "falconPackageHash": "f7f210eef43674d6221d872892796140d99ffdf03b83e8e70b25df23"
+  "falconPackageHash": "fa580baad5f4160561ec52a958fbb6abf2d10c8b223ba9398b031f3f"
 }