@wix/web-methods 0.1.0

package/build/index.d.ts

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

package/build/index.js

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

package/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/build/permissions.js

@@ -0,0 +1,20 @@
+export var Roles;
+(function (Roles) {
+    Roles["SITE_OWNER"] = "siteOwner";
+    Roles["SITE_MEMBER"] = "siteMember";
+    Roles["ANONYMOUS"] = "anonymous";
+})(Roles || (Roles = {}));
+var PermissionOptions;
+(function (PermissionOptions) {
+    PermissionOptions["Admin"] = "Admin";
+    PermissionOptions["SiteMember"] = "SiteMember";
+    PermissionOptions["Anyone"] = "Anyone";
+})(PermissionOptions || (PermissionOptions = {}));
+const { SITE_OWNER, SITE_MEMBER, ANONYMOUS } = Roles;
+export const WEB_METHOD_OPTIONS_PROPERTY_NAME = 'options';
+export const WEB_METHOD_PERMISSIONS_PROPERTY_NAME = 'permission';
+export const Permissions = {
+    Admin: { allowedRoles: [SITE_OWNER] },
+    SiteMember: { allowedRoles: [SITE_OWNER, SITE_MEMBER] },
+    Anyone: { allowedRoles: [SITE_OWNER, SITE_MEMBER, ANONYMOUS] },
+};

package/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/build/types.js

@@ -0,0 +1 @@
+export {};

package/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/build/web-method.js

@@ -0,0 +1,12 @@
+import { WEB_METHOD_OPTIONS_PROPERTY_NAME, WEB_METHOD_PERMISSIONS_PROPERTY_NAME, } from './permissions.js';
+// https://dev.wix.com/docs/velo/api-reference/wix-web-module/introduction
+export function webMethod(permission, method, options) {
+    const webMethodEnrichment = {
+        [WEB_METHOD_PERMISSIONS_PROPERTY_NAME]: permission,
+        ...(options && { [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/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@wix/web-methods",
+  "version": "0.1.0",
+  "type": "module",
+  "exports": {
+    ".": "./build/index.js",
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "files": [
+    "build"
+  ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": ":",
+    "lint": "eslint --max-warnings=0 .",
+    "lint:fix": "eslint --max-warnings=0 . --fix",
+    "typecheck": "tsc --noEmit"
+  },
+  "lint-staged": {
+    "*.{js,ts}": "yarn lint"
+  },
+  "devDependencies": {
+    "eslint": "^8.57.1",
+    "eslint-config-sdk": "0.0.0",
+    "typescript": "^5.7.2"
+  },
+  "eslintConfig": {
+    "extends": "sdk"
+  },
+  "wix": {
+    "artifact": {
+      "groupId": "com.wixpress",
+      "artifactId": "web-methods"
+    },
+    "validations": {
+      "source": [
+        "lint"
+      ],
+      "postDependenciesBuild": [
+        "typecheck"
+      ]
+    }
+  },
+  "falconPackageHash": "f7f210eef43674d6221d872892796140d99ffdf03b83e8e70b25df23"
+}