@cedarjs/testing 0.1.1-next.0 → 0.1.2-next.95

package/dist/api/index.js

@@ -1,26 +1,3 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var api_exports = {};
-module.exports = __toCommonJS(api_exports);
-__reExport(api_exports, require("./apiFunction"), module.exports);
-__reExport(api_exports, require("./scenario"), module.exports);
-__reExport(api_exports, require("./directive"), module.exports);
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  ...require("./apiFunction"),
-  ...require("./scenario"),
-  ...require("./directive")
-});
+export * from "./apiFunction.js";
+export * from "./scenario.js";
+export * from "./directive.js";

package/dist/api/scenario.js

@@ -1,30 +1,6 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var scenario_exports = {};
-__export(scenario_exports, {
-  defineScenario: () => defineScenario
-});
-module.exports = __toCommonJS(scenario_exports);
 const defineScenario = (data) => {
   return data;
 };
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
+export {
   defineScenario
-});
+};

package/dist/cache/index.js

@@ -1,26 +1,3 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var cache_exports = {};
-__export(cache_exports, {
-  partialMatch: () => partialMatch
-});
-module.exports = __toCommonJS(cache_exports);
 expect.extend({
   toHaveCached(cacheClient, keyOrExpectedValue, expectedValue) {
     let value;
@@ -98,7 +75,6 @@ const _checkValueForKey = (cacheClient, cacheKey, expectedValue) => {
 const partialMatch = (value) => {
   return Array.isArray(value) ? expect.arrayContaining(value.map((v) => expect.objectContaining(v))) : expect.objectContaining(value);
 };
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
+export {
   partialMatch
-});
+};

package/dist/cjs/api/apiFunction.d.ts

@@ -0,0 +1,37 @@
+import type { APIGatewayProxyEvent, APIGatewayProxyEventHeaders, Context } from 'aws-lambda';
+import type { SupportedVerifierTypes } from '@cedarjs/api/webhooks';
+interface BuildEventParams extends Partial<APIGatewayProxyEvent> {
+    payload?: string | null | Record<any, any>;
+    signature?: string;
+    signatureHeader?: string;
+    headers?: APIGatewayProxyEventHeaders;
+}
+/**
+ * @description Use this to mock out the http request event that is received by your function in unit tests
+ *
+ * @example Mocking sending headers
+ * mockHttpEvent({header: {'X-Custom-Header': 'bazinga'}})
+ *
+ * @example Adding a JSON payload
+ * mockHttpEvent({payload: JSON.stringify(mockedRequestBody)})
+ *
+ * @returns APIGatewayProxyEvent
+ */
+export declare const mockHttpEvent: ({ payload, signature, signatureHeader, queryStringParameters, httpMethod, headers, path, isBase64Encoded, ...others }: BuildEventParams) => APIGatewayProxyEvent;
+/**
+ * @description Use this function to mock the http event's context
+ * @see: https://docs.aws.amazon.com/lambda/latest/dg/nodejs-context.html
+ **/
+export declare const mockContext: () => Context;
+interface MockedSignedWebhookParams extends Omit<BuildEventParams, 'signature' | 'signatureHeader'> {
+    signatureType: Exclude<SupportedVerifierTypes, 'skipVerifier'>;
+    signatureHeader: string;
+    secret: string;
+}
+/**
+ * @description Use this function to mock a signed webhook
+ * @see https://redwoodjs.com/docs/webhooks#webhooks
+ **/
+export declare const mockSignedWebhook: ({ payload, signatureType, signatureHeader, secret, ...others }: MockedSignedWebhookParams) => APIGatewayProxyEvent;
+export {};
+//# sourceMappingURL=apiFunction.d.ts.map

package/dist/cjs/api/apiFunction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiFunction.d.ts","sourceRoot":"","sources":["../../../src/api/apiFunction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,2BAA2B,EAC3B,OAAO,EACR,MAAM,YAAY,CAAA;AAEnB,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAA;AAGnE,UAAU,gBAAiB,SAAQ,OAAO,CAAC,oBAAoB,CAAC;IAC9D,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;IAC1C,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,OAAO,CAAC,EAAE,2BAA2B,CAAA;CACtC;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,aAAa,0HAUvB,gBAAgB,KAAG,oBAgCrB,CAAA;AAED;;;IAGI;AACJ,eAAO,MAAM,WAAW,QAAO,OAI9B,CAAA;AAED,UAAU,yBACR,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,GAAG,iBAAiB,CAAC;IAC/D,aAAa,EAAE,OAAO,CAAC,sBAAsB,EAAE,cAAc,CAAC,CAAA;IAC9D,eAAe,EAAE,MAAM,CAAA;IACvB,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;;IAGI;AACJ,eAAO,MAAM,iBAAiB,mEAM3B,yBAAyB,yBAe3B,CAAA"}

package/dist/cjs/api/apiFunction.js

@@ -0,0 +1,89 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var apiFunction_exports = {};
+__export(apiFunction_exports, {
+  mockContext: () => mockContext,
+  mockHttpEvent: () => mockHttpEvent,
+  mockSignedWebhook: () => mockSignedWebhook
+});
+module.exports = __toCommonJS(apiFunction_exports);
+var import_webhooks = require("@cedarjs/api/webhooks");
+const mockHttpEvent = ({
+  payload = null,
+  signature,
+  signatureHeader,
+  queryStringParameters = null,
+  httpMethod = "GET",
+  headers = {},
+  path = "",
+  isBase64Encoded = false,
+  ...others
+}) => {
+  if (signature && signatureHeader) {
+    headers[signatureHeader.toLocaleLowerCase()] = signature;
+  }
+  const payloadAsString = typeof payload === "string" ? payload : JSON.stringify(payload);
+  const body = payload === null ? null : isBase64Encoded ? Buffer.from(payloadAsString || "").toString("base64") : payloadAsString;
+  return {
+    body,
+    headers,
+    multiValueHeaders: {},
+    isBase64Encoded,
+    path,
+    pathParameters: null,
+    stageVariables: null,
+    httpMethod,
+    queryStringParameters,
+    // @ts-expect-error not required for mocks
+    requestContext: null,
+    // @ts-expect-error not required for mocks
+    resource: null,
+    multiValueQueryStringParameters: null,
+    ...others
+  };
+};
+const mockContext = () => {
+  const context = {};
+  return context;
+};
+const mockSignedWebhook = ({
+  payload = null,
+  signatureType,
+  signatureHeader,
+  secret,
+  ...others
+}) => {
+  const payloadAsString = typeof payload === "string" ? payload : JSON.stringify(payload);
+  const signature = (0, import_webhooks.signPayload)(signatureType, {
+    payload: payloadAsString,
+    secret
+  });
+  return mockHttpEvent({
+    payload,
+    signature,
+    signatureHeader,
+    ...others
+  });
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  mockContext,
+  mockHttpEvent,
+  mockSignedWebhook
+});

package/dist/cjs/api/directUrlHelpers.d.ts

@@ -0,0 +1,3 @@
+export declare function getDefaultDb(rwjsCwd: string): string;
+export declare function checkAndReplaceDirectUrl(prismaSchema: string, defaultDb: string): string | undefined;
+//# sourceMappingURL=directUrlHelpers.d.ts.map

package/dist/cjs/api/directUrlHelpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"directUrlHelpers.d.ts","sourceRoot":"","sources":["../../../src/api/directUrlHelpers.ts"],"names":[],"mappings":"AAEA,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,UAE3C;AAED,wBAAgB,wBAAwB,CACtC,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,sBA2BlB"}

package/dist/cjs/api/directUrlHelpers.js

@@ -0,0 +1,60 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var directUrlHelpers_exports = {};
+__export(directUrlHelpers_exports, {
+  checkAndReplaceDirectUrl: () => checkAndReplaceDirectUrl,
+  getDefaultDb: () => getDefaultDb
+});
+module.exports = __toCommonJS(directUrlHelpers_exports);
+var import_path = __toESM(require("path"), 1);
+function getDefaultDb(rwjsCwd) {
+  return `file:${import_path.default.join(rwjsCwd, ".redwood", "test.db")}`;
+}
+function checkAndReplaceDirectUrl(prismaSchema, defaultDb) {
+  const directUrl = prismaSchema.match(PRISMA_DIRECT_URL_REGEXP);
+  if (!directUrl) {
+    return;
+  }
+  const directUrlEnvMatch = directUrl[0].match(BETWEEN_PARENTHESES_REGEXP);
+  if (!directUrlEnvMatch) {
+    throw new Error(
+      "Error parsing `directUrl` from schema.prisma. Proceeding with this env var could be dangerous. Please check your schema.prisma file; if everything looks ok, file an issue."
+    );
+  }
+  const directUrlEnv = directUrlEnvMatch[2];
+  process.env[directUrlEnv] = process.env.TEST_DIRECT_URL || process.env.TEST_DATABASE_URL || defaultDb;
+  return directUrlEnv;
+}
+const PRISMA_DIRECT_URL_REGEXP = /directUrl(\s*)=(\s*)env\(('|")(.*)('|")\)/g;
+const BETWEEN_PARENTHESES_REGEXP = /\(('|")([^)]+)('|")\)/;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  checkAndReplaceDirectUrl,
+  getDefaultDb
+});

package/dist/cjs/api/directive.d.ts

@@ -0,0 +1,51 @@
+import type { A } from 'ts-toolbelt';
+import type { DirectiveParams, ValidatorDirective, TransformerDirective } from '@cedarjs/graphql-server';
+export { getDirectiveName } from '@cedarjs/graphql-server';
+interface DirectiveMocker {
+    (directive: ValidatorDirective, executionMock: A.Compute<Omit<Partial<DirectiveParams>, 'resolvedValue'>>): any;
+}
+type TransformerMock = A.Compute<Omit<Partial<DirectiveParams>, 'resolvedValue'>> & {
+    mockedResolvedValue: any;
+};
+interface DirectiveMocker {
+    (directive: TransformerDirective, executionMock: TransformerMock): any;
+}
+/**
+ * @description
+ *
+ * Used for writing both synchronous and asynchronous directive tests e.g.
+ *
+ * - Transformer directives can be passed mockedResolvedValue
+ * - Validator directives should check for errors thrown in certain situations
+ * - Can provide args, directiveArgs and context to mock directive execution
+ *
+ * @example
+ *
+ * Synchronous transformer directive:
+ *
+ * ```ts
+ * const mockExecution = mockRedwoodDirective(myTransformer, {
+ *   context: currentUser,
+ *   mockedResolvedValue: 'Original Value',
+ * })
+ *
+ * expect(mockExecution).not.toThrow()
+ * expect(mockExecution()).toEqual('Transformed Value')
+ * ```ts
+ *
+ * @example
+ *
+ * Asynchronous transformer directive:
+ *
+ * ```ts
+ * const mockExecution = mockRedwoodDirective(myTransformer, {
+ *   context: currentUser,
+ *   mockedResolvedValue: 'Original Value',
+ * })
+ *
+ * await expect(mockExecution).resolves.not.toThrow()
+ * await expect(mockExecution()).resolves.toEqual('Transformed Value')
+ * ```
+ */
+export declare const mockRedwoodDirective: DirectiveMocker;
+//# sourceMappingURL=directive.d.ts.map

package/dist/cjs/api/directive.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"directive.d.ts","sourceRoot":"","sources":["../../../src/api/directive.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,aAAa,CAAA;AAGpC,OAAO,KAAK,EACV,eAAe,EACf,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,yBAAyB,CAAA;AAGhC,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAA;AAG1D,UAAU,eAAe;IACvB,CACE,SAAS,EAAE,kBAAkB,EAC7B,aAAa,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,eAAe,CAAC,CAAC,GACxE,GAAG,CAAA;CACP;AAED,KAAK,eAAe,GAAG,CAAC,CAAC,OAAO,CAC9B,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,eAAe,CAAC,CAChD,GAAG;IACF,mBAAmB,EAAE,GAAG,CAAA;CACzB,CAAA;AAGD,UAAU,eAAe;IACvB,CAAC,SAAS,EAAE,oBAAoB,EAAE,aAAa,EAAE,eAAe,GAAG,GAAG,CAAA;CACvE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,eAAO,MAAM,oBAAoB,EAAE,eAmDlC,CAAA"}

package/dist/cjs/api/directive.js

@@ -0,0 +1,77 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var directive_exports = {};
+__export(directive_exports, {
+  getDirectiveName: () => import_graphql_server2.getDirectiveName,
+  mockRedwoodDirective: () => mockRedwoodDirective
+});
+module.exports = __toCommonJS(directive_exports);
+var import_context = require("@cedarjs/context");
+var import_graphql_server = require("@cedarjs/graphql-server");
+var import_graphql_server2 = require("@cedarjs/graphql-server");
+const mockRedwoodDirective = (directive, executionMock) => {
+  const { directiveArgs, context, ...others } = executionMock;
+  if (directive.onResolvedValue.constructor.name === "AsyncFunction") {
+    return async () => {
+      if (context !== void 0) {
+        (0, import_context.setContext)(context);
+      }
+      if (directive.type === import_graphql_server.DirectiveType.TRANSFORMER) {
+        const { mockedResolvedValue } = others;
+        return directive.onResolvedValue({
+          resolvedValue: mockedResolvedValue,
+          directiveArgs: directiveArgs ?? {},
+          context: import_context.context,
+          ...others
+        });
+      } else {
+        await directive.onResolvedValue({
+          directiveArgs: directiveArgs ?? {},
+          context: import_context.context,
+          ...others
+        });
+      }
+    };
+  }
+  return () => {
+    if (context !== void 0) {
+      (0, import_context.setContext)(context);
+    }
+    if (directive.type === import_graphql_server.DirectiveType.TRANSFORMER) {
+      const { mockedResolvedValue } = others;
+      return directive.onResolvedValue({
+        resolvedValue: mockedResolvedValue,
+        directiveArgs: directiveArgs ?? {},
+        context: import_context.context,
+        ...others
+      });
+    } else {
+      directive.onResolvedValue({
+        directiveArgs: directiveArgs ?? {},
+        context: import_context.context,
+        ...others
+      });
+    }
+  };
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getDirectiveName,
+  mockRedwoodDirective
+});

package/dist/cjs/api/index.d.ts

@@ -0,0 +1,4 @@
+export * from './apiFunction.js';
+export * from './scenario.js';
+export * from './directive.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/api/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAA;AAChC,cAAc,eAAe,CAAA;AAC7B,cAAc,gBAAgB,CAAA"}

package/dist/cjs/api/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var api_exports = {};
+module.exports = __toCommonJS(api_exports);
+__reExport(api_exports, require("./apiFunction.js"), module.exports);
+__reExport(api_exports, require("./scenario.js"), module.exports);
+__reExport(api_exports, require("./directive.js"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("./apiFunction.js"),
+  ...require("./scenario.js"),
+  ...require("./directive.js")
+});

package/dist/cjs/api/scenario.d.ts

@@ -0,0 +1,108 @@
+import type { A } from 'ts-toolbelt';
+/**
+ * Use this function to define your scenario.
+ *
+ * @example
+ * export const standard = defineScenario({
+ *   user: {
+ *     dom: {
+ *       name: 'Dom Saadi',
+ *       email: 'dom@cedarjs.com',
+ *     },
+ *   },
+ * })
+ *
+ * @example
+ * export const standard = defineScenario<Prisma.CreateUserArgs>({
+ *   user: {
+ *     dom: {
+ *       name: 'Dom Saadi',
+ *       email: 'dom@cedarjs.com',
+ *     },
+ *   },
+ * })
+ */
+export declare const defineScenario: DefineScenario;
+/**
+ * @example
+ * {
+ *   dannyUser: {
+ *     data: {
+ *       id: 1,
+ *       name: 'Danny',
+ *     },
+ *   },
+ * }
+ *
+ * @example
+ *   krisUser: (scenario) => {
+ *     return {
+ *       data: {
+ *         id: 2,
+ *         name: 'Kris',
+ *       },
+ *     }
+ *   }
+ */
+type ScenarioDefinitionMap<PrismaCreateType extends {
+    data: any;
+}, ModelName extends string | number | symbol = string | number | symbol, TKeys extends string | number | symbol = string | number | symbol> = Record<TKeys, A.Compute<PrismaCreateType> | ((scenario: Record<ModelName, Record<TKeys, any>>) => A.Compute<PrismaCreateType>)>;
+export interface DefineScenario {
+    <PrismaCreateType extends {
+        data: any;
+    }, ModelName extends string | number | symbol = string | number | symbol, TKeys extends string | number | symbol = string | number | symbol>(scenarioMap: Record<ModelName, ScenarioDefinitionMap<PrismaCreateType, ModelName, TKeys>>): Record<ModelName, Record<TKeys, any>>;
+}
+/**
+ * Type of data seeded by the scenario. Use this type to get the 'strict' return type of defineScenario
+ *
+ * @example
+ * import { Product } from '@prisma/client'
+ *
+ * // If you scenario looks like this:
+ * export const standard = defineScenario({
+ *   product: {
+ *     shirt: {
+ *       id: 55,
+ *       price: 10,
+ *     },
+ *   },
+ * })
+ *
+ * // Export the StandardScenario type as
+ * export StandardScenario = ScenarioData<Product, 'product'>
+ *
+ * // You can also define each of the keys in your scenario, so you get stricter type checking
+ * export StandardScenario = ScenarioData<Product, 'product', 'shirt'>
+ */
+export declare type ScenarioData<TModel, // the prisma model, imported from @prisma/client e.g. "Product"
+TName extends string | number = string | number, // (optional) name of the prisma model e.g. "product"
+TKeys extends string | number = string | number> = Record<TName, Record<TKeys, TModel>>;
+interface TestFunctionWithScenario<TData> {
+    (scenario?: TData): Promise<void>;
+}
+interface DescribeBlockWithGetScenario<TData> {
+    (getScenario: () => TData): void;
+}
+export interface Scenario {
+    (title: string, testFunction: TestFunctionWithScenario<any>): void;
+}
+export interface Scenario {
+    (namedScenario: string, title: string, testFunction: TestFunctionWithScenario<any>): void;
+}
+export interface Scenario {
+    only: Scenario;
+}
+export interface DescribeScenario {
+    <TData = any>(title: string, describeBlock: DescribeBlockWithGetScenario<TData>): void;
+}
+export interface DescribeScenario {
+    <TData>(title: string, describeBlock: DescribeBlockWithGetScenario<TData>): void;
+}
+export interface DescribeScenario {
+    <TData>(namedScenario: string, title: string, describeBlock: DescribeBlockWithGetScenario<TData>): void;
+}
+export interface DescribeScenario {
+    only: DescribeScenario;
+}
+export {};
+//# sourceMappingURL=scenario.d.ts.map

package/dist/cjs/api/scenario.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scenario.d.ts","sourceRoot":"","sources":["../../../src/api/scenario.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,aAAa,CAAA;AAEpC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,cAAc,EAAE,cAE5B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,KAAK,qBAAqB,CACxB,gBAAgB,SAAS;IAAE,IAAI,EAAE,GAAG,CAAA;CAAE,EACtC,SAAS,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,EACrE,KAAK,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,IAC/D,MAAM,CACR,KAAK,EACH,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,GAC3B,CAAC,CACC,QAAQ,EAAE,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,KAC5C,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CACpC,CAAA;AAaD,MAAM,WAAW,cAAc;IAC7B,CACE,gBAAgB,SAAS;QAAE,IAAI,EAAE,GAAG,CAAA;KAAE,EACtC,SAAS,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,EACrE,KAAK,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,EAEjE,WAAW,EAAE,MAAM,CACjB,SAAS,EACT,qBAAqB,CAAC,gBAAgB,EAAE,SAAS,EAAE,KAAK,CAAC,CAC1D,GACA,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAA;CACzC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,OAAO,MAAM,YAAY,CAC9B,MAAM,EAAE,gEAAgE;AACxE,KAAK,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,qDAAqD;AACtG,KAAK,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,IAC7C,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAA;AAExC,UAAU,wBAAwB,CAAC,KAAK;IACtC,CAAC,QAAQ,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAClC;AAED,UAAU,4BAA4B,CAAC,KAAK;IAC1C,CAAC,WAAW,EAAE,MAAM,KAAK,GAAG,IAAI,CAAA;CACjC;AAED,MAAM,WAAW,QAAQ;IACvB,CAAC,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,wBAAwB,CAAC,GAAG,CAAC,GAAG,IAAI,CAAA;CACnE;AAGD,MAAM,WAAW,QAAQ;IACvB,CACE,aAAa,EAAE,MAAM,EACrB,KAAK,EAAE,MAAM,EACb,YAAY,EAAE,wBAAwB,CAAC,GAAG,CAAC,GAC1C,IAAI,CAAA;CACR;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,QAAQ,CAAA;CACf;AAED,MAAM,WAAW,gBAAgB;IAC/B,CAAC,KAAK,GAAG,GAAG,EACV,KAAK,EAAE,MAAM,EACb,aAAa,EAAE,4BAA4B,CAAC,KAAK,CAAC,GACjD,IAAI,CAAA;CACR;AAED,MAAM,WAAW,gBAAgB;IAC/B,CAAC,KAAK,EACJ,KAAK,EAAE,MAAM,EACb,aAAa,EAAE,4BAA4B,CAAC,KAAK,CAAC,GACjD,IAAI,CAAA;CACR;AAGD,MAAM,WAAW,gBAAgB;IAC/B,CAAC,KAAK,EACJ,aAAa,EAAE,MAAM,EACrB,KAAK,EAAE,MAAM,EACb,aAAa,EAAE,4BAA4B,CAAC,KAAK,CAAC,GACjD,IAAI,CAAA;CACR;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,gBAAgB,CAAA;CACvB"}

package/dist/cjs/api/scenario.js

@@ -0,0 +1,30 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var scenario_exports = {};
+__export(scenario_exports, {
+  defineScenario: () => defineScenario
+});
+module.exports = __toCommonJS(scenario_exports);
+const defineScenario = (data) => {
+  return data;
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  defineScenario
+});

package/dist/cjs/cache/index.d.ts

@@ -0,0 +1,50 @@
+type AsymmetricMatcher = {
+    $$typeof: symbol;
+};
+type ExpectedValue = any[] | any | AsymmetricMatcher;
+type ExpectedKey = string | RegExp;
+declare global {
+    namespace jest {
+        interface Matchers<R> {
+            /**
+             *
+             * Use this helper to simplify testing your InMemoryCache client.
+             *
+             * The expected value you provide will be serialized and deseriliazed for you.
+             *
+             * NOTE: Does not support partialMatch - use cacheClient.contents or test with a key!
+             * @param expectedValue The value that is cached, must be serializable
+             */
+            toHaveCached(expectedValue: unknown): R;
+            /**
+             *
+             * Use this helper to simplify testing your InMemoryCache client.
+             *
+             *
+             * @param cacheKey They key that your value is cached under
+             * @param expectedValue The expected value. Can be a jest asymmetric matcher (using `partialMatch`)
+             */
+            toHaveCached(cacheKey: ExpectedKey, expectedValue: ExpectedValue): R;
+        }
+    }
+}
+/**
+ * This is just syntactic sugar, to help with testing cache contents.
+ *
+ * If you pass an array, it will check arrays for a partial match of the object.
+ *
+ * If you pass an object, it will check for a partial match of the object.
+ *
+ * Useful when you don't want to compare dates/auto-generated ids etc.
+ *
+ * @example
+ * expect(testCacheClient.contents).toContainEqual(partialMatch({ title: 'Only look for this title'}))
+ *
+ * @example
+ * expect(testCacheClient.contents).toContainEqual(partialMatch([{id: 1}, {id: 2}]))
+ *
+ * @param value Object or Array of object to match
+ */
+export declare const partialMatch: (value: Record<any, any> | Record<any, any>[]) => any;
+export {};
+//# sourceMappingURL=index.d.ts.map