@wix/essentials 0.1.8 → 0.1.10

package/build/auth.d.ts

@@ -1,21 +1,67 @@
 import { RESTFunctionDescriptor } from '@wix/sdk-types';
 export declare function elevate<T extends RESTFunctionDescriptor>(restModule: T): T;
+/**
+ * Returns the information encoded in the currently active token in API backend extensions.
+ *
+ * When developing API backend extensions you might need to access information about the session that is making the request.
+ *
+ * This can include the user ID, the site ID, the instance ID, and more. This information is encoded in the token that is sent with the request
+ * and can be accessed using this function.
+ * @returns A promise that resolves to the token info.
+ * @example
+ * ```ts
+ * // In an API backend extension in a Wix CLI project
+ * import { auth } from '@wix/essentials';
+ *
+ * export async function GET(req: Request) {
+ *  const tokenInfo = await auth.getTokenInfo();
+ *
+ *  if (tokenInfo.subjectType === 'USER') {
+ *    return new Response(`Hello user ${tokenInfo.subjectId}`);
+ *  } else if (tokenInfo.subjectType === 'APP') {
+ *    return new Response('Hello app');
+ *  } else if (tokenInfo.subjectType === 'MEMBER') {
+ *    return new Response(`Hello member ${tokenInfo.subjectId}`);
+ *  } else {
+ *    return new Response(`Hello visitor ${tokenInfo.subjectId}`);
+ *  }
+ * }
+ * ```
+ * @example
+ * ```ts
+ * // In a Velo web method
+ * import { auth } from '@wix/essentials';
+ * import { Permissions, webMethod } from 'wix-web-module';
+ *
+ * export const sayHello = webMethod(Permimissions.Anyone, async () => {
+ *  const tokenInfo = await auth.getTokenInfo();
+ *
+ * if (tokenInfo.subjectType === 'USER') {
+ *  return `Hello user ${tokenInfo.subjectId}`;
+ * } else if (tokenInfo.subjectType === 'APP') {
+ *  return 'Hello app';
+ * } else if (tokenInfo.subjectType === 'MEMBER') {
+ *  return `Hello member ${tokenInfo.subjectId}`;
+ * } else {
+ *  return `Hello visitor ${tokenInfo.subjectId}`;
+ * }
+ */
 export declare const getTokenInfo: (() => Promise<{
     active: boolean;
-    subjectType: 'APP' | 'USER' | 'MEMBER' | 'VISITOR' | 'UNKNOWN';
+    subjectType: "APP" | "USER" | "MEMBER" | "VISITOR" | "UNKNOWN";
     subjectId: string;
     exp: number;
     iat: number;
-    clientId?: string | undefined;
+    clientId?: string;
     siteId: string;
-    instanceId?: string | undefined;
+    instanceId?: string;
 }>) & ((restModuleOpts: import("@wix/sdk-types").HttpClient) => () => Promise<{
     active: boolean;
-    subjectType: 'APP' | 'USER' | 'MEMBER' | 'VISITOR' | 'UNKNOWN';
+    subjectType: "APP" | "USER" | "MEMBER" | "VISITOR" | "UNKNOWN";
     subjectId: string;
     exp: number;
     iat: number;
-    clientId?: string | undefined;
+    clientId?: string;
     siteId: string;
-    instanceId?: string | undefined;
+    instanceId?: string;
 }>);

package/build/auth.js

@@ -2,6 +2,52 @@ import { createRESTModule } from '@wix/sdk-runtime/rest-modules';
 export function elevate(restModule) {
     return createRESTModule(restModule, true);
 }
+/**
+ * Returns the information encoded in the currently active token in API backend extensions.
+ *
+ * When developing API backend extensions you might need to access information about the session that is making the request.
+ *
+ * This can include the user ID, the site ID, the instance ID, and more. This information is encoded in the token that is sent with the request
+ * and can be accessed using this function.
+ * @returns A promise that resolves to the token info.
+ * @example
+ * ```ts
+ * // In an API backend extension in a Wix CLI project
+ * import { auth } from '@wix/essentials';
+ *
+ * export async function GET(req: Request) {
+ *  const tokenInfo = await auth.getTokenInfo();
+ *
+ *  if (tokenInfo.subjectType === 'USER') {
+ *    return new Response(`Hello user ${tokenInfo.subjectId}`);
+ *  } else if (tokenInfo.subjectType === 'APP') {
+ *    return new Response('Hello app');
+ *  } else if (tokenInfo.subjectType === 'MEMBER') {
+ *    return new Response(`Hello member ${tokenInfo.subjectId}`);
+ *  } else {
+ *    return new Response(`Hello visitor ${tokenInfo.subjectId}`);
+ *  }
+ * }
+ * ```
+ * @example
+ * ```ts
+ * // In a Velo web method
+ * import { auth } from '@wix/essentials';
+ * import { Permissions, webMethod } from 'wix-web-module';
+ *
+ * export const sayHello = webMethod(Permimissions.Anyone, async () => {
+ *  const tokenInfo = await auth.getTokenInfo();
+ *
+ * if (tokenInfo.subjectType === 'USER') {
+ *  return `Hello user ${tokenInfo.subjectId}`;
+ * } else if (tokenInfo.subjectType === 'APP') {
+ *  return 'Hello app';
+ * } else if (tokenInfo.subjectType === 'MEMBER') {
+ *  return `Hello member ${tokenInfo.subjectId}`;
+ * } else {
+ *  return `Hello visitor ${tokenInfo.subjectId}`;
+ * }
+ */
 export const getTokenInfo = createRESTModule((restModuleOpts) => {
     return async () => {
         if (!restModuleOpts.getActiveToken) {

package/build/http-client.d.ts

@@ -1,16 +1,16 @@
 import { DocumentNode, GraphQLFormattedError } from 'graphql';
 import { RESTFunctionDescriptor } from '@wix/sdk-types';
 export declare const fetchWithAuth: typeof fetch & ((restModuleOpts: import("@wix/sdk-types").HttpClient) => typeof fetch);
-export declare const graphql: (<Result, Variables>(query: string | String | DocumentNode | TypedQueryInput<Result, Variables>, variables?: Variables | undefined, opts?: {
+export declare const graphql: (<Result, Variables>(query: string | String | DocumentNode | TypedQueryInput<Result, Variables>, variables?: Variables, opts?: {
     apiVersion: string;
 }) => Promise<{
     data: Result;
-    errors?: GraphQLFormattedError[] | undefined;
-}>) & RESTFunctionDescriptor<(<Result, Variables>(query: string | String | DocumentNode | TypedQueryInput<Result, Variables>, variables?: Variables | undefined, opts?: {
+    errors?: GraphQLFormattedError[];
+}>) & RESTFunctionDescriptor<(<Result, Variables>(query: string | String | DocumentNode | TypedQueryInput<Result, Variables>, variables?: Variables, opts?: {
     apiVersion: string;
 }) => Promise<{
     data: Result;
-    errors?: GraphQLFormattedError[] | undefined;
+    errors?: GraphQLFormattedError[];
 }>)>;
 export type TypedQueryInput<Result = {
     [key: string]: any;

package/build/index.d.ts

@@ -1,4 +1,5 @@
 import * as auth from './auth.js';
 import * as httpClient from './http-client.js';
-export { auth, httpClient };
+import * as webMethods from './web-methods.js';
+export { auth, httpClient, webMethods };
 export { i18n } from './i18n.js';

package/build/index.js

@@ -1,4 +1,5 @@
 import * as auth from './auth.js';
 import * as httpClient from './http-client.js';
-export { auth, httpClient };
+import * as webMethods from './web-methods.js';
+export { auth, httpClient, webMethods };
 export { i18n } from './i18n.js';

package/build/web-methods.d.ts

@@ -0,0 +1,8 @@
+type Handler<T extends unknown[], R> = (...args: T) => R;
+export declare function webMethod<T extends unknown[], R>(permission: Permissions, handler: Handler<T, R>): Handler<T, Promise<Awaited<R>>>;
+export declare enum Permissions {
+    Anyone = "anyone",
+    Admin = "admin",
+    SiteMember = "site-member"
+}
+export {};

package/build/web-methods.js

@@ -0,0 +1,14 @@
+// https://dev.wix.com/docs/velo/api-reference/wix-web-module/introduction
+export function webMethod(permission, handler) {
+    return {
+        handler,
+        permission,
+        // The type assertion is necessary so developers using this get the types they expect
+    };
+}
+export var Permissions;
+(function (Permissions) {
+    Permissions["Anyone"] = "anyone";
+    Permissions["Admin"] = "admin";
+    Permissions["SiteMember"] = "site-member";
+})(Permissions || (Permissions = {}));

package/cjs/build/auth.d.ts

@@ -1,21 +1,67 @@
 import { RESTFunctionDescriptor } from '@wix/sdk-types';
 export declare function elevate<T extends RESTFunctionDescriptor>(restModule: T): T;
+/**
+ * Returns the information encoded in the currently active token in API backend extensions.
+ *
+ * When developing API backend extensions you might need to access information about the session that is making the request.
+ *
+ * This can include the user ID, the site ID, the instance ID, and more. This information is encoded in the token that is sent with the request
+ * and can be accessed using this function.
+ * @returns A promise that resolves to the token info.
+ * @example
+ * ```ts
+ * // In an API backend extension in a Wix CLI project
+ * import { auth } from '@wix/essentials';
+ *
+ * export async function GET(req: Request) {
+ *  const tokenInfo = await auth.getTokenInfo();
+ *
+ *  if (tokenInfo.subjectType === 'USER') {
+ *    return new Response(`Hello user ${tokenInfo.subjectId}`);
+ *  } else if (tokenInfo.subjectType === 'APP') {
+ *    return new Response('Hello app');
+ *  } else if (tokenInfo.subjectType === 'MEMBER') {
+ *    return new Response(`Hello member ${tokenInfo.subjectId}`);
+ *  } else {
+ *    return new Response(`Hello visitor ${tokenInfo.subjectId}`);
+ *  }
+ * }
+ * ```
+ * @example
+ * ```ts
+ * // In a Velo web method
+ * import { auth } from '@wix/essentials';
+ * import { Permissions, webMethod } from 'wix-web-module';
+ *
+ * export const sayHello = webMethod(Permimissions.Anyone, async () => {
+ *  const tokenInfo = await auth.getTokenInfo();
+ *
+ * if (tokenInfo.subjectType === 'USER') {
+ *  return `Hello user ${tokenInfo.subjectId}`;
+ * } else if (tokenInfo.subjectType === 'APP') {
+ *  return 'Hello app';
+ * } else if (tokenInfo.subjectType === 'MEMBER') {
+ *  return `Hello member ${tokenInfo.subjectId}`;
+ * } else {
+ *  return `Hello visitor ${tokenInfo.subjectId}`;
+ * }
+ */
 export declare const getTokenInfo: (() => Promise<{
     active: boolean;
-    subjectType: 'APP' | 'USER' | 'MEMBER' | 'VISITOR' | 'UNKNOWN';
+    subjectType: "APP" | "USER" | "MEMBER" | "VISITOR" | "UNKNOWN";
     subjectId: string;
     exp: number;
     iat: number;
-    clientId?: string | undefined;
+    clientId?: string;
     siteId: string;
-    instanceId?: string | undefined;
+    instanceId?: string;
 }>) & ((restModuleOpts: import("@wix/sdk-types").HttpClient) => () => Promise<{
     active: boolean;
-    subjectType: 'APP' | 'USER' | 'MEMBER' | 'VISITOR' | 'UNKNOWN';
+    subjectType: "APP" | "USER" | "MEMBER" | "VISITOR" | "UNKNOWN";
     subjectId: string;
     exp: number;
     iat: number;
-    clientId?: string | undefined;
+    clientId?: string;
     siteId: string;
-    instanceId?: string | undefined;
+    instanceId?: string;
 }>);

package/cjs/build/auth.js

@@ -1,11 +1,57 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTokenInfo = exports.elevate = void 0;
+exports.getTokenInfo = void 0;
+exports.elevate = elevate;
 const rest_modules_1 = require("@wix/sdk-runtime/rest-modules");
 function elevate(restModule) {
     return (0, rest_modules_1.createRESTModule)(restModule, true);
 }
-exports.elevate = elevate;
+/**
+ * Returns the information encoded in the currently active token in API backend extensions.
+ *
+ * When developing API backend extensions you might need to access information about the session that is making the request.
+ *
+ * This can include the user ID, the site ID, the instance ID, and more. This information is encoded in the token that is sent with the request
+ * and can be accessed using this function.
+ * @returns A promise that resolves to the token info.
+ * @example
+ * ```ts
+ * // In an API backend extension in a Wix CLI project
+ * import { auth } from '@wix/essentials';
+ *
+ * export async function GET(req: Request) {
+ *  const tokenInfo = await auth.getTokenInfo();
+ *
+ *  if (tokenInfo.subjectType === 'USER') {
+ *    return new Response(`Hello user ${tokenInfo.subjectId}`);
+ *  } else if (tokenInfo.subjectType === 'APP') {
+ *    return new Response('Hello app');
+ *  } else if (tokenInfo.subjectType === 'MEMBER') {
+ *    return new Response(`Hello member ${tokenInfo.subjectId}`);
+ *  } else {
+ *    return new Response(`Hello visitor ${tokenInfo.subjectId}`);
+ *  }
+ * }
+ * ```
+ * @example
+ * ```ts
+ * // In a Velo web method
+ * import { auth } from '@wix/essentials';
+ * import { Permissions, webMethod } from 'wix-web-module';
+ *
+ * export const sayHello = webMethod(Permimissions.Anyone, async () => {
+ *  const tokenInfo = await auth.getTokenInfo();
+ *
+ * if (tokenInfo.subjectType === 'USER') {
+ *  return `Hello user ${tokenInfo.subjectId}`;
+ * } else if (tokenInfo.subjectType === 'APP') {
+ *  return 'Hello app';
+ * } else if (tokenInfo.subjectType === 'MEMBER') {
+ *  return `Hello member ${tokenInfo.subjectId}`;
+ * } else {
+ *  return `Hello visitor ${tokenInfo.subjectId}`;
+ * }
+ */
 exports.getTokenInfo = (0, rest_modules_1.createRESTModule)((restModuleOpts) => {
     return async () => {
         if (!restModuleOpts.getActiveToken) {

package/cjs/build/http-client.d.ts

@@ -1,16 +1,16 @@
 import { DocumentNode, GraphQLFormattedError } from 'graphql';
 import { RESTFunctionDescriptor } from '@wix/sdk-types';
 export declare const fetchWithAuth: typeof fetch & ((restModuleOpts: import("@wix/sdk-types").HttpClient) => typeof fetch);
-export declare const graphql: (<Result, Variables>(query: string | String | DocumentNode | TypedQueryInput<Result, Variables>, variables?: Variables | undefined, opts?: {
+export declare const graphql: (<Result, Variables>(query: string | String | DocumentNode | TypedQueryInput<Result, Variables>, variables?: Variables, opts?: {
     apiVersion: string;
 }) => Promise<{
     data: Result;
-    errors?: GraphQLFormattedError[] | undefined;
-}>) & RESTFunctionDescriptor<(<Result, Variables>(query: string | String | DocumentNode | TypedQueryInput<Result, Variables>, variables?: Variables | undefined, opts?: {
+    errors?: GraphQLFormattedError[];
+}>) & RESTFunctionDescriptor<(<Result, Variables>(query: string | String | DocumentNode | TypedQueryInput<Result, Variables>, variables?: Variables, opts?: {
     apiVersion: string;
 }) => Promise<{
     data: Result;
-    errors?: GraphQLFormattedError[] | undefined;
+    errors?: GraphQLFormattedError[];
 }>)>;
 export type TypedQueryInput<Result = {
     [key: string]: any;

package/cjs/build/index.d.ts

@@ -1,4 +1,5 @@
 import * as auth from './auth.js';
 import * as httpClient from './http-client.js';
-export { auth, httpClient };
+import * as webMethods from './web-methods.js';
+export { auth, httpClient, webMethods };
 export { i18n } from './i18n.js';

package/cjs/build/index.js

@@ -15,18 +15,30 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.i18n = exports.httpClient = exports.auth = void 0;
+exports.i18n = exports.webMethods = exports.httpClient = exports.auth = void 0;
 const auth = __importStar(require("./auth.js"));
 exports.auth = auth;
 const httpClient = __importStar(require("./http-client.js"));
 exports.httpClient = httpClient;
+const webMethods = __importStar(require("./web-methods.js"));
+exports.webMethods = webMethods;
 var i18n_js_1 = require("./i18n.js");
 Object.defineProperty(exports, "i18n", { enumerable: true, get: function () { return i18n_js_1.i18n; } });

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

@@ -0,0 +1,8 @@
+type Handler<T extends unknown[], R> = (...args: T) => R;
+export declare function webMethod<T extends unknown[], R>(permission: Permissions, handler: Handler<T, R>): Handler<T, Promise<Awaited<R>>>;
+export declare enum Permissions {
+    Anyone = "anyone",
+    Admin = "admin",
+    SiteMember = "site-member"
+}
+export {};

package/cjs/build/web-methods.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Permissions = void 0;
+exports.webMethod = webMethod;
+// https://dev.wix.com/docs/velo/api-reference/wix-web-module/introduction
+function webMethod(permission, handler) {
+    return {
+        handler,
+        permission,
+        // The type assertion is necessary so developers using this get the types they expect
+    };
+}
+var Permissions;
+(function (Permissions) {
+    Permissions["Anyone"] = "anyone";
+    Permissions["Admin"] = "admin";
+    Permissions["SiteMember"] = "site-member";
+})(Permissions || (exports.Permissions = Permissions = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/essentials",
-  "version": "0.1.8",
+  "version": "0.1.10",
   "license": "UNLICENSED",
   "main": "cjs/build/index.js",
   "module": "build/index.mjs",
@@ -13,6 +13,9 @@
     "./package.json": "./package.json"
   },
   "sideEffects": false,
+  "keywords": [
+    "wix-sdk-module=backend,page,public"
+  ],
   "files": [
     "build",
     "cjs"
@@ -32,26 +35,26 @@
     "*.{js,ts}": "yarn lint"
   },
   "dependencies": {
-    "@wix/sdk-runtime": "^0.3.21",
-    "@wix/sdk-types": "^1.12.3"
+    "@wix/sdk-runtime": "^0.3.24",
+    "@wix/sdk-types": "^1.12.4"
   },
   "optionalDependencies": {
     "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0"
   },
   "devDependencies": {
     "@types/is-ci": "^3.0.4",
-    "@types/node": "^20.10.6",
-    "@vitest/ui": "^1.5.0",
-    "@wix/sdk": "1.14.1",
-    "eslint": "^8.56.0",
+    "@types/node": "^20.17.9",
+    "@vitest/ui": "^1.6.0",
+    "@wix/sdk": "1.14.4",
+    "eslint": "^8.57.1",
     "eslint-config-sdk": "0.0.0",
     "graphql": "^16.8.0",
     "is-ci": "^3.0.1",
     "jsdom": "^22.1.0",
-    "msw": "^2.4.5",
-    "typescript": "^5.3.3",
-    "vitest": "^1.5.0",
-    "vitest-teamcity-reporter": "^0.3.0"
+    "msw": "^2.6.6",
+    "typescript": "^5.7.2",
+    "vitest": "^1.6.0",
+    "vitest-teamcity-reporter": "^0.3.1"
   },
   "eslintConfig": {
     "extends": "sdk"
@@ -70,5 +73,5 @@
       ]
     }
   },
-  "falconPackageHash": "93165f2988c7cfab1c5bffb6a15c467d48775c9205707b5ed63f41e1"
+  "falconPackageHash": "89b3fc54d75286af87e57b252a4f02bc1fc55b7fc2d44a71e9faf0b4"
 }