@depup/payload 3.79.1-depup.0

package/dist/auth/types.d.ts

@@ -0,0 +1,273 @@
+import type { DeepRequired } from 'ts-essentials';
+import type { CollectionSlug, GlobalSlug, Payload, TypedUser } from '../index.js';
+import type { PayloadRequest, Where } from '../types/index.js';
+/**
+ * A permission object that can be used to determine if a user has access to a specific operation.
+ */
+export type Permission = {
+    permission: boolean;
+    where?: Where;
+};
+export type FieldsPermissions = {
+    [fieldName: string]: FieldPermissions;
+};
+export type BlockPermissions = {
+    create: Permission;
+    fields: FieldsPermissions;
+    read: Permission;
+    update: Permission;
+};
+export type SanitizedBlockPermissions = {
+    fields: SanitizedFieldsPermissions;
+} | true;
+export type BlocksPermissions = {
+    [blockSlug: string]: BlockPermissions;
+};
+export type SanitizedBlocksPermissions = {
+    [blockSlug: string]: SanitizedBlockPermissions;
+} | true;
+export type FieldPermissions = {
+    blocks?: BlocksPermissions;
+    create?: Permission;
+    fields?: FieldsPermissions;
+    read?: Permission;
+    update?: Permission;
+};
+export type SanitizedFieldPermissions = {
+    blocks?: SanitizedBlocksPermissions;
+    create: true;
+    fields?: SanitizedFieldsPermissions;
+    read: true;
+    update: true;
+} | true;
+export type SanitizedFieldsPermissions = {
+    [fieldName: string]: SanitizedFieldPermissions;
+} | true;
+export type CollectionPermission = {
+    create?: Permission;
+    delete?: Permission;
+    fields: FieldsPermissions;
+    read?: Permission;
+    readVersions?: Permission;
+    unlock?: Permission;
+    update?: Permission;
+};
+export type SanitizedCollectionPermission = {
+    create?: true;
+    delete?: true;
+    fields: SanitizedFieldsPermissions;
+    read?: true;
+    readVersions?: true;
+    unlock?: true;
+    update?: true;
+};
+export type GlobalPermission = {
+    fields: FieldsPermissions;
+    read?: Permission;
+    readVersions?: Permission;
+    update?: Permission;
+};
+export type SanitizedGlobalPermission = {
+    fields: SanitizedFieldsPermissions;
+    read?: true;
+    readVersions?: true;
+    update?: true;
+};
+export type DocumentPermissions = CollectionPermission | GlobalPermission;
+export type SanitizedDocumentPermissions = SanitizedCollectionPermission | SanitizedGlobalPermission;
+export type Permissions = {
+    canAccessAdmin: boolean;
+    collections?: Record<CollectionSlug, CollectionPermission>;
+    globals?: Record<GlobalSlug, GlobalPermission>;
+};
+export type SanitizedPermissions = {
+    canAccessAdmin?: boolean;
+    collections?: {
+        [collectionSlug: string]: SanitizedCollectionPermission;
+    };
+    globals?: {
+        [globalSlug: string]: SanitizedGlobalPermission;
+    };
+};
+type BaseUser = {
+    collection: string;
+    email?: string;
+    id: number | string;
+    sessions?: Array<UserSession>;
+    username?: string;
+};
+/**
+ * @deprecated Use `TypedUser` instead. This will be removed in 4.0.
+ */
+export type UntypedUser = {
+    [key: string]: any;
+} & BaseUser;
+/**
+ * `collection` is not available one the client. It's only available on the server (req.user)
+ * On the client, you can access the collection via config.admin.user. Config can be accessed using the useConfig() hook
+ */
+export type ClientUser = {
+    [key: string]: any;
+} & BaseUser;
+export type UserSession = {
+    createdAt: Date | string;
+    expiresAt: Date | string;
+    id: string;
+};
+type GenerateVerifyEmailHTML<TUser = any> = (args: {
+    req: PayloadRequest;
+    token: string;
+    user: TUser;
+}) => Promise<string> | string;
+type GenerateVerifyEmailSubject<TUser = any> = (args: {
+    req: PayloadRequest;
+    token: string;
+    user: TUser;
+}) => Promise<string> | string;
+type GenerateForgotPasswordEmailHTML<TUser = any> = (args?: {
+    req?: PayloadRequest;
+    token?: string;
+    user?: TUser;
+}) => Promise<string> | string;
+type GenerateForgotPasswordEmailSubject<TUser = any> = (args?: {
+    req?: PayloadRequest;
+    token?: string;
+    user?: TUser;
+}) => Promise<string> | string;
+export type AuthStrategyFunctionArgs = {
+    /**
+     * Specifies whether or not response headers can be set from this strategy.
+     */
+    canSetHeaders?: boolean;
+    headers: Request['headers'];
+    isGraphQL?: boolean;
+    payload: Payload;
+    /**
+     * The AuthStrategy name property from the payload config.
+     */
+    strategyName?: string;
+};
+export type AuthStrategyResult = {
+    responseHeaders?: Headers;
+    user: ({
+        _strategy?: string;
+        collection?: string;
+    } & TypedUser) | null;
+};
+export type AuthStrategyFunction = (args: AuthStrategyFunctionArgs) => AuthStrategyResult | Promise<AuthStrategyResult>;
+export type AuthStrategy = {
+    authenticate: AuthStrategyFunction;
+    name: string;
+};
+export type LoginWithUsernameOptions = {
+    allowEmailLogin?: false;
+    requireEmail?: boolean;
+    requireUsername?: true;
+} | {
+    allowEmailLogin?: true;
+    requireEmail?: boolean;
+    requireUsername?: boolean;
+};
+export interface IncomingAuthType {
+    /**
+     * Set cookie options, including secure, sameSite, and domain. For advanced users.
+     */
+    cookies?: {
+        domain?: string;
+        sameSite?: 'Lax' | 'None' | 'Strict' | boolean;
+        secure?: boolean;
+    };
+    /**
+     * How many levels deep a user document should be populated when creating the JWT and binding the user to the req. Defaults to 0 and should only be modified if absolutely necessary, as this will affect performance.
+     * @default 0
+     */
+    depth?: number;
+    /**
+     * Advanced - disable Payload's built-in local auth strategy. Only use this property if you have replaced Payload's auth mechanisms with your own.
+     */
+    disableLocalStrategy?: {
+        /**
+         * Include auth fields on the collection even though the local strategy is disabled.
+         * Useful when you do not want the database or types to vary depending on the auth configuration.
+         */
+        enableFields?: true;
+        optionalPassword?: true;
+    } | true;
+    /**
+     * Customize the way that the forgotPassword operation functions.
+     * @link https://payloadcms.com/docs/authentication/email#forgot-password
+     */
+    forgotPassword?: {
+        /**
+         * The number of milliseconds that the forgot password token should be valid for.
+         * @default 3600000 // 1 hour
+         */
+        expiration?: number;
+        generateEmailHTML?: GenerateForgotPasswordEmailHTML;
+        generateEmailSubject?: GenerateForgotPasswordEmailSubject;
+    };
+    /**
+     * Set the time (in milliseconds) that a user should be locked out if they fail authentication more times than maxLoginAttempts allows for.
+     */
+    lockTime?: number;
+    /**
+     * Ability to allow users to login with username/password.
+     *
+     * @link https://payloadcms.com/docs/authentication/overview#login-with-username
+     */
+    loginWithUsername?: boolean | LoginWithUsernameOptions;
+    /**
+     * Only allow a user to attempt logging in X amount of times. Automatically locks out a user from authenticating if this limit is passed. Set to 0 to disable.
+     */
+    maxLoginAttempts?: number;
+    /***
+     * Set to true if you want to remove the token from the returned authentication API responses such as login or refresh.
+     */
+    removeTokenFromResponses?: true;
+    /**
+     * Advanced - an array of custom authentification strategies to extend this collection's authentication with.
+     * @link https://payloadcms.com/docs/authentication/custom-strategies
+     */
+    strategies?: AuthStrategy[];
+    /**
+     * Controls how many seconds the token will be valid for. Default is 2 hours.
+     * @default 7200
+     * @link https://payloadcms.com/docs/authentication/overview#config-options
+     */
+    tokenExpiration?: number;
+    /**
+     * Payload Authentication provides for API keys to be set on each user within an Authentication-enabled Collection.
+     * @default false
+     * @link https://payloadcms.com/docs/authentication/api-keys
+     */
+    useAPIKey?: boolean;
+    /**
+     * Use sessions for authentication. Enabled by default.
+     * @default true
+     */
+    useSessions?: boolean;
+    /**
+     * Set to true or pass an object with verification options to require users to verify by email before they are allowed to log into your app.
+     * @link https://payloadcms.com/docs/authentication/email#email-verification
+     */
+    verify?: {
+        generateEmailHTML?: GenerateVerifyEmailHTML;
+        generateEmailSubject?: GenerateVerifyEmailSubject;
+    } | boolean;
+}
+export type VerifyConfig = {
+    generateEmailHTML?: GenerateVerifyEmailHTML;
+    generateEmailSubject?: GenerateVerifyEmailSubject;
+};
+export interface Auth extends Omit<DeepRequired<IncomingAuthType>, 'forgotPassword' | 'loginWithUsername' | 'verify'> {
+    forgotPassword?: {
+        expiration?: number;
+        generateEmailHTML?: GenerateForgotPasswordEmailHTML;
+        generateEmailSubject?: GenerateForgotPasswordEmailSubject;
+    };
+    loginWithUsername: false | LoginWithUsernameOptions;
+    verify?: boolean | VerifyConfig;
+}
+export declare function hasWhereAccessResult(result: boolean | Where): result is Where;
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/auth/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/auth/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAEjD,OAAO,KAAK,EAAE,cAAc,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACjF,OAAO,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAE9D;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,UAAU,EAAE,OAAO,CAAA;IACnB,KAAK,CAAC,EAAE,KAAK,CAAA;CACd,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,CAAC,SAAS,EAAE,MAAM,GAAG,gBAAgB,CAAA;CACtC,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,UAAU,CAAA;IAClB,MAAM,EAAE,iBAAiB,CAAA;IACzB,IAAI,EAAE,UAAU,CAAA;IAChB,MAAM,EAAE,UAAU,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,yBAAyB,GACjC;IACE,MAAM,EAAE,0BAA0B,CAAA;CACnC,GACD,IAAI,CAAA;AAER,MAAM,MAAM,iBAAiB,GAAG;IAC9B,CAAC,SAAS,EAAE,MAAM,GAAG,gBAAgB,CAAA;CACtC,CAAA;AAED,MAAM,MAAM,0BAA0B,GAClC;IACE,CAAC,SAAS,EAAE,MAAM,GAAG,yBAAyB,CAAA;CAC/C,GACD,IAAI,CAAA;AAER,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,CAAC,EAAE,iBAAiB,CAAA;IAC1B,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB,MAAM,CAAC,EAAE,iBAAiB,CAAA;IAC1B,IAAI,CAAC,EAAE,UAAU,CAAA;IACjB,MAAM,CAAC,EAAE,UAAU,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,yBAAyB,GACjC;IACE,MAAM,CAAC,EAAE,0BAA0B,CAAA;IACnC,MAAM,EAAE,IAAI,CAAA;IACZ,MAAM,CAAC,EAAE,0BAA0B,CAAA;IACnC,IAAI,EAAE,IAAI,CAAA;IACV,MAAM,EAAE,IAAI,CAAA;CACb,GACD,IAAI,CAAA;AAER,MAAM,MAAM,0BAA0B,GAClC;IACE,CAAC,SAAS,EAAE,MAAM,GAAG,yBAAyB,CAAA;CAC/C,GACD,IAAI,CAAA;AAER,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB,MAAM,EAAE,iBAAiB,CAAA;IACzB,IAAI,CAAC,EAAE,UAAU,CAAA;IACjB,YAAY,CAAC,EAAE,UAAU,CAAA;IAEzB,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB,MAAM,CAAC,EAAE,UAAU,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,6BAA6B,GAAG;IAC1C,MAAM,CAAC,EAAE,IAAI,CAAA;IACb,MAAM,CAAC,EAAE,IAAI,CAAA;IACb,MAAM,EAAE,0BAA0B,CAAA;IAClC,IAAI,CAAC,EAAE,IAAI,CAAA;IACX,YAAY,CAAC,EAAE,IAAI,CAAA;IAEnB,MAAM,CAAC,EAAE,IAAI,CAAA;IACb,MAAM,CAAC,EAAE,IAAI,CAAA;CACd,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,iBAAiB,CAAA;IACzB,IAAI,CAAC,EAAE,UAAU,CAAA;IACjB,YAAY,CAAC,EAAE,UAAU,CAAA;IACzB,MAAM,CAAC,EAAE,UAAU,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,MAAM,EAAE,0BAA0B,CAAA;IAClC,IAAI,CAAC,EAAE,IAAI,CAAA;IACX,YAAY,CAAC,EAAE,IAAI,CAAA;IACnB,MAAM,CAAC,EAAE,IAAI,CAAA;CACd,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,GAAG,gBAAgB,CAAA;AAEzE,MAAM,MAAM,4BAA4B,GAAG,6BAA6B,GAAG,yBAAyB,CAAA;AAEpG,MAAM,MAAM,WAAW,GAAG;IACxB,cAAc,EAAE,OAAO,CAAA;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC,cAAc,EAAE,oBAAoB,CAAC,CAAA;IAC1D,OAAO,CAAC,EAAE,MAAM,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAA;CAC/C,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,WAAW,CAAC,EAAE;QACZ,CAAC,cAAc,EAAE,MAAM,GAAG,6BAA6B,CAAA;KACxD,CAAA;IACD,OAAO,CAAC,EAAE;QACR,CAAC,UAAU,EAAE,MAAM,GAAG,yBAAyB,CAAA;KAChD,CAAA;CACF,CAAA;AAED,KAAK,QAAQ,GAAG;IACd,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,CAAA;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACnB,GAAG,QAAQ,CAAA;AAEZ;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACnB,GAAG,QAAQ,CAAA;AAEZ,MAAM,MAAM,WAAW,GAAG;IAAE,SAAS,EAAE,IAAI,GAAG,MAAM,CAAC;IAAC,SAAS,EAAE,IAAI,GAAG,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,CAAA;AAC5F,KAAK,uBAAuB,CAAC,KAAK,GAAG,GAAG,IAAI,CAAC,IAAI,EAAE;IACjD,GAAG,EAAE,cAAc,CAAA;IACnB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,KAAK,CAAA;CACZ,KAAK,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAA;AAE9B,KAAK,0BAA0B,CAAC,KAAK,GAAG,GAAG,IAAI,CAAC,IAAI,EAAE;IACpD,GAAG,EAAE,cAAc,CAAA;IACnB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,KAAK,CAAA;CACZ,KAAK,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAA;AAE9B,KAAK,+BAA+B,CAAC,KAAK,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE;IAC1D,GAAG,CAAC,EAAE,cAAc,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,KAAK,CAAA;CACb,KAAK,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAA;AAE9B,KAAK,kCAAkC,CAAC,KAAK,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE;IAC7D,GAAG,CAAC,EAAE,cAAc,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,KAAK,CAAA;CACb,KAAK,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAA;AAE9B,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,CAAA;IAC3B,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,OAAO,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,IAAI,EACA,CAAC;QACC,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,UAAU,CAAC,EAAE,MAAM,CAAA;KACpB,GAAG,SAAS,CAAC,GACd,IAAI,CAAA;CACT,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,CACjC,IAAI,EAAE,wBAAwB,KAC3B,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAA;AACrD,MAAM,MAAM,YAAY,GAAG;IACzB,YAAY,EAAE,oBAAoB,CAAA;IAClC,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,wBAAwB,GAChC;IACE,eAAe,CAAC,EAAE,KAAK,CAAA;IACvB,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB,eAAe,CAAC,EAAE,IAAI,CAAA;CACvB,GACD;IACE,eAAe,CAAC,EAAE,IAAI,CAAA;IACtB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B,CAAA;AAEL,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,QAAQ,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAA;QAC9C,MAAM,CAAC,EAAE,OAAO,CAAA;KACjB,CAAA;IACD;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,oBAAoB,CAAC,EACjB;QACE;;;WAGG;QACH,YAAY,CAAC,EAAE,IAAI,CAAA;QACnB,gBAAgB,CAAC,EAAE,IAAI,CAAA;KACxB,GACD,IAAI,CAAA;IACR;;;OAGG;IACH,cAAc,CAAC,EAAE;QACf;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,iBAAiB,CAAC,EAAE,+BAA+B,CAAA;QACnD,oBAAoB,CAAC,EAAE,kCAAkC,CAAA;KAC1D,CAAA;IACD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,GAAG,wBAAwB,CAAA;IACtD;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;OAEG;IACH,wBAAwB,CAAC,EAAE,IAAI,CAAA;IAC/B;;;OAGG;IACH,UAAU,CAAC,EAAE,YAAY,EAAE,CAAA;IAC3B;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IAEnB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IAErB;;;OAGG;IACH,MAAM,CAAC,EACH;QACE,iBAAiB,CAAC,EAAE,uBAAuB,CAAA;QAC3C,oBAAoB,CAAC,EAAE,0BAA0B,CAAA;KAClD,GACD,OAAO,CAAA;CACZ;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,iBAAiB,CAAC,EAAE,uBAAuB,CAAA;IAC3C,oBAAoB,CAAC,EAAE,0BAA0B,CAAA;CAClD,CAAA;AAED,MAAM,WAAW,IACf,SAAQ,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,mBAAmB,GAAG,QAAQ,CAAC;IAC/F,cAAc,CAAC,EAAE;QACf,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,iBAAiB,CAAC,EAAE,+BAA+B,CAAA;QACnD,oBAAoB,CAAC,EAAE,kCAAkC,CAAA;KAC1D,CAAA;IACD,iBAAiB,EAAE,KAAK,GAAG,wBAAwB,CAAA;IACnD,MAAM,CAAC,EAAE,OAAO,GAAG,YAAY,CAAA;CAChC;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,KAAK,GAAG,MAAM,IAAI,KAAK,CAE7E"}

package/dist/auth/types.js

@@ -0,0 +1,5 @@
+export function hasWhereAccessResult(result) {
+    return result && typeof result === 'object';
+}
+
+//# sourceMappingURL=types.js.map

package/dist/auth/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/auth/types.ts"],"sourcesContent":["import type { DeepRequired } from 'ts-essentials'\n\nimport type { CollectionSlug, GlobalSlug, Payload, TypedUser } from '../index.js'\nimport type { PayloadRequest, Where } from '../types/index.js'\n\n/**\n * A permission object that can be used to determine if a user has access to a specific operation.\n */\nexport type Permission = {\n  permission: boolean\n  where?: Where\n}\n\nexport type FieldsPermissions = {\n  [fieldName: string]: FieldPermissions\n}\n\nexport type BlockPermissions = {\n  create: Permission\n  fields: FieldsPermissions\n  read: Permission\n  update: Permission\n}\n\nexport type SanitizedBlockPermissions =\n  | {\n      fields: SanitizedFieldsPermissions\n    }\n  | true\n\nexport type BlocksPermissions = {\n  [blockSlug: string]: BlockPermissions\n}\n\nexport type SanitizedBlocksPermissions =\n  | {\n      [blockSlug: string]: SanitizedBlockPermissions\n    }\n  | true\n\nexport type FieldPermissions = {\n  blocks?: BlocksPermissions\n  create?: Permission\n  fields?: FieldsPermissions\n  read?: Permission\n  update?: Permission\n}\n\nexport type SanitizedFieldPermissions =\n  | {\n      blocks?: SanitizedBlocksPermissions\n      create: true\n      fields?: SanitizedFieldsPermissions\n      read: true\n      update: true\n    }\n  | true\n\nexport type SanitizedFieldsPermissions =\n  | {\n      [fieldName: string]: SanitizedFieldPermissions\n    }\n  | true\n\nexport type CollectionPermission = {\n  create?: Permission\n  delete?: Permission\n  fields: FieldsPermissions\n  read?: Permission\n  readVersions?: Permission\n  // Auth-enabled Collections only\n  unlock?: Permission\n  update?: Permission\n}\n\nexport type SanitizedCollectionPermission = {\n  create?: true\n  delete?: true\n  fields: SanitizedFieldsPermissions\n  read?: true\n  readVersions?: true\n  // Auth-enabled Collections only\n  unlock?: true\n  update?: true\n}\n\nexport type GlobalPermission = {\n  fields: FieldsPermissions\n  read?: Permission\n  readVersions?: Permission\n  update?: Permission\n}\n\nexport type SanitizedGlobalPermission = {\n  fields: SanitizedFieldsPermissions\n  read?: true\n  readVersions?: true\n  update?: true\n}\n\nexport type DocumentPermissions = CollectionPermission | GlobalPermission\n\nexport type SanitizedDocumentPermissions = SanitizedCollectionPermission | SanitizedGlobalPermission\n\nexport type Permissions = {\n  canAccessAdmin: boolean\n  collections?: Record<CollectionSlug, CollectionPermission>\n  globals?: Record<GlobalSlug, GlobalPermission>\n}\n\nexport type SanitizedPermissions = {\n  canAccessAdmin?: boolean\n  collections?: {\n    [collectionSlug: string]: SanitizedCollectionPermission\n  }\n  globals?: {\n    [globalSlug: string]: SanitizedGlobalPermission\n  }\n}\n\ntype BaseUser = {\n  collection: string\n  email?: string\n  id: number | string\n  sessions?: Array<UserSession>\n  username?: string\n}\n\n/**\n * @deprecated Use `TypedUser` instead. This will be removed in 4.0.\n */\nexport type UntypedUser = {\n  [key: string]: any\n} & BaseUser\n\n/**\n * `collection` is not available one the client. It's only available on the server (req.user)\n * On the client, you can access the collection via config.admin.user. Config can be accessed using the useConfig() hook\n */\nexport type ClientUser = {\n  [key: string]: any\n} & BaseUser\n\nexport type UserSession = { createdAt: Date | string; expiresAt: Date | string; id: string }\ntype GenerateVerifyEmailHTML<TUser = any> = (args: {\n  req: PayloadRequest\n  token: string\n  user: TUser\n}) => Promise<string> | string\n\ntype GenerateVerifyEmailSubject<TUser = any> = (args: {\n  req: PayloadRequest\n  token: string\n  user: TUser\n}) => Promise<string> | string\n\ntype GenerateForgotPasswordEmailHTML<TUser = any> = (args?: {\n  req?: PayloadRequest\n  token?: string\n  user?: TUser\n}) => Promise<string> | string\n\ntype GenerateForgotPasswordEmailSubject<TUser = any> = (args?: {\n  req?: PayloadRequest\n  token?: string\n  user?: TUser\n}) => Promise<string> | string\n\nexport type AuthStrategyFunctionArgs = {\n  /**\n   * Specifies whether or not response headers can be set from this strategy.\n   */\n  canSetHeaders?: boolean\n  headers: Request['headers']\n  isGraphQL?: boolean\n  payload: Payload\n  /**\n   * The AuthStrategy name property from the payload config.\n   */\n  strategyName?: string\n}\n\nexport type AuthStrategyResult = {\n  responseHeaders?: Headers\n  user:\n    | ({\n        _strategy?: string\n        collection?: string\n      } & TypedUser)\n    | null\n}\n\nexport type AuthStrategyFunction = (\n  args: AuthStrategyFunctionArgs,\n) => AuthStrategyResult | Promise<AuthStrategyResult>\nexport type AuthStrategy = {\n  authenticate: AuthStrategyFunction\n  name: string\n}\n\nexport type LoginWithUsernameOptions =\n  | {\n      allowEmailLogin?: false\n      requireEmail?: boolean\n      // If `allowEmailLogin` is false, `requireUsername` must be true (default: true)\n      requireUsername?: true\n    }\n  | {\n      allowEmailLogin?: true\n      requireEmail?: boolean\n      requireUsername?: boolean\n    }\n\nexport interface IncomingAuthType {\n  /**\n   * Set cookie options, including secure, sameSite, and domain. For advanced users.\n   */\n  cookies?: {\n    domain?: string\n    sameSite?: 'Lax' | 'None' | 'Strict' | boolean\n    secure?: boolean\n  }\n  /**\n   * How many levels deep a user document should be populated when creating the JWT and binding the user to the req. Defaults to 0 and should only be modified if absolutely necessary, as this will affect performance.\n   * @default 0\n   */\n  depth?: number\n  /**\n   * Advanced - disable Payload's built-in local auth strategy. Only use this property if you have replaced Payload's auth mechanisms with your own.\n   */\n  disableLocalStrategy?:\n    | {\n        /**\n         * Include auth fields on the collection even though the local strategy is disabled.\n         * Useful when you do not want the database or types to vary depending on the auth configuration.\n         */\n        enableFields?: true\n        optionalPassword?: true\n      }\n    | true\n  /**\n   * Customize the way that the forgotPassword operation functions.\n   * @link https://payloadcms.com/docs/authentication/email#forgot-password\n   */\n  forgotPassword?: {\n    /**\n     * The number of milliseconds that the forgot password token should be valid for.\n     * @default 3600000 // 1 hour\n     */\n    expiration?: number\n    generateEmailHTML?: GenerateForgotPasswordEmailHTML\n    generateEmailSubject?: GenerateForgotPasswordEmailSubject\n  }\n  /**\n   * Set the time (in milliseconds) that a user should be locked out if they fail authentication more times than maxLoginAttempts allows for.\n   */\n  lockTime?: number\n  /**\n   * Ability to allow users to login with username/password.\n   *\n   * @link https://payloadcms.com/docs/authentication/overview#login-with-username\n   */\n  loginWithUsername?: boolean | LoginWithUsernameOptions\n  /**\n   * Only allow a user to attempt logging in X amount of times. Automatically locks out a user from authenticating if this limit is passed. Set to 0 to disable.\n   */\n  maxLoginAttempts?: number\n  /***\n   * Set to true if you want to remove the token from the returned authentication API responses such as login or refresh.\n   */\n  removeTokenFromResponses?: true\n  /**\n   * Advanced - an array of custom authentification strategies to extend this collection's authentication with.\n   * @link https://payloadcms.com/docs/authentication/custom-strategies\n   */\n  strategies?: AuthStrategy[]\n  /**\n   * Controls how many seconds the token will be valid for. Default is 2 hours.\n   * @default 7200\n   * @link https://payloadcms.com/docs/authentication/overview#config-options\n   */\n  tokenExpiration?: number\n  /**\n   * Payload Authentication provides for API keys to be set on each user within an Authentication-enabled Collection.\n   * @default false\n   * @link https://payloadcms.com/docs/authentication/api-keys\n   */\n  useAPIKey?: boolean\n\n  /**\n   * Use sessions for authentication. Enabled by default.\n   * @default true\n   */\n  useSessions?: boolean\n\n  /**\n   * Set to true or pass an object with verification options to require users to verify by email before they are allowed to log into your app.\n   * @link https://payloadcms.com/docs/authentication/email#email-verification\n   */\n  verify?:\n    | {\n        generateEmailHTML?: GenerateVerifyEmailHTML\n        generateEmailSubject?: GenerateVerifyEmailSubject\n      }\n    | boolean\n}\n\nexport type VerifyConfig = {\n  generateEmailHTML?: GenerateVerifyEmailHTML\n  generateEmailSubject?: GenerateVerifyEmailSubject\n}\n\nexport interface Auth\n  extends Omit<DeepRequired<IncomingAuthType>, 'forgotPassword' | 'loginWithUsername' | 'verify'> {\n  forgotPassword?: {\n    expiration?: number\n    generateEmailHTML?: GenerateForgotPasswordEmailHTML\n    generateEmailSubject?: GenerateForgotPasswordEmailSubject\n  }\n  loginWithUsername: false | LoginWithUsernameOptions\n  verify?: boolean | VerifyConfig\n}\n\nexport function hasWhereAccessResult(result: boolean | Where): result is Where {\n  return result && typeof result === 'object'\n}\n"],"names":["hasWhereAccessResult","result"],"mappings":"AAmUA,OAAO,SAASA,qBAAqBC,MAAuB;IAC1D,OAAOA,UAAU,OAAOA,WAAW;AACrC"}

package/dist/bin/generateImportMap/generateImportMap.spec.js

@@ -0,0 +1,176 @@
+import { describe, beforeEach, expect, it, vitest } from 'vitest';
+import { addPayloadComponentToImportMap } from './utilities/addPayloadComponentToImportMap.js';
+import { getImportMapToBaseDirPath } from './utilities/getImportMapToBaseDirPath.js';
+describe('addPayloadComponentToImportMap', ()=>{
+    let importMap;
+    let imports;
+    beforeEach(()=>{
+        importMap = {};
+        imports = {};
+        vitest.restoreAllMocks();
+    });
+    function componentPathTest({ baseDir, importMapFilePath, payloadComponent, expectedPath, expectedSpecifier, expectedImportMapToBaseDirPath }) {
+        const importMapToBaseDirPath = getImportMapToBaseDirPath({
+            baseDir,
+            importMapPath: importMapFilePath
+        });
+        expect(importMapToBaseDirPath).toBe(expectedImportMapToBaseDirPath);
+        const { path, specifier } = addPayloadComponentToImportMap({
+            importMapToBaseDirPath,
+            importMap,
+            imports,
+            payloadComponent
+        }) ?? {};
+        expect(path).toBe(expectedPath);
+        expect(specifier).toBe(expectedSpecifier);
+    }
+    it('relative path with import map partially in base dir', ()=>{
+        componentPathTest({
+            baseDir: '/myPackage/test/myTest',
+            importMapFilePath: '/myPackage/app/(payload)/importMap.js',
+            payloadComponent: './MyComponent.js#MyExport',
+            expectedImportMapToBaseDirPath: '../../test/myTest/',
+            expectedPath: '../../test/myTest/MyComponent.js',
+            expectedSpecifier: 'MyExport'
+        });
+    });
+    it('relative path with import map partially in base dir 2', ()=>{
+        componentPathTest({
+            baseDir: '/myPackage/test/myTest',
+            importMapFilePath: '/myPackage/test/prod/app/(payload)/importMap.js',
+            payloadComponent: {
+                path: './MyComponent.js#MyExport'
+            },
+            expectedImportMapToBaseDirPath: '../../../myTest/',
+            expectedPath: '../../../myTest/MyComponent.js',
+            expectedSpecifier: 'MyExport'
+        });
+    });
+    it('relative path with import map partially in base dir 3', ()=>{
+        componentPathTest({
+            baseDir: '/myPackage/test/myTest',
+            importMapFilePath: '/myPackage/test/prod/app/(payload)/importMap.js',
+            payloadComponent: {
+                path: '../otherTest/MyComponent.js',
+                exportName: 'MyExport'
+            },
+            expectedImportMapToBaseDirPath: '../../../myTest/',
+            expectedPath: '../../../otherTest/MyComponent.js',
+            expectedSpecifier: 'MyExport'
+        });
+    });
+    it('relative path with import map within base dir', ()=>{
+        componentPathTest({
+            baseDir: '/myPackage/test/myTest',
+            importMapFilePath: '/myPackage/test/myTest/prod/app/(payload)/importMap.js',
+            payloadComponent: './MyComponent.js#MyExport',
+            expectedImportMapToBaseDirPath: '../../../',
+            expectedPath: '../../../MyComponent.js',
+            expectedSpecifier: 'MyExport'
+        });
+    });
+    it('relative path with import map not in base dir', ()=>{
+        componentPathTest({
+            baseDir: '/test/myTest',
+            importMapFilePath: '/app/(payload)/importMap.js',
+            payloadComponent: './MyComponent.js#MyExport',
+            expectedImportMapToBaseDirPath: '../../test/myTest/',
+            expectedPath: '../../test/myTest/MyComponent.js',
+            expectedSpecifier: 'MyExport'
+        });
+    });
+    it('relative path with import map not in base dir 2', ()=>{
+        componentPathTest({
+            baseDir: '/test/myTest',
+            importMapFilePath: '/app/(payload)/importMap.js',
+            payloadComponent: '../myOtherTest/MyComponent.js#MyExport',
+            expectedImportMapToBaseDirPath: '../../test/myTest/',
+            expectedPath: '../../test/myOtherTest/MyComponent.js',
+            expectedSpecifier: 'MyExport'
+        });
+    });
+    it('relative path with import map not in base dir, baseDir ending with slash', ()=>{
+        componentPathTest({
+            baseDir: '/test/myTest/',
+            importMapFilePath: '/app/(payload)/importMap.js',
+            payloadComponent: './MyComponent.js#MyExport',
+            expectedImportMapToBaseDirPath: '../../test/myTest/',
+            expectedPath: '../../test/myTest/MyComponent.js',
+            expectedSpecifier: 'MyExport'
+        });
+    });
+    it('relative path with import map not in base dir, component starting with slash', ()=>{
+        componentPathTest({
+            baseDir: '/test/myTest',
+            importMapFilePath: '/app/(payload)/importMap.js',
+            payloadComponent: '/MyComponent.js#MyExport',
+            expectedImportMapToBaseDirPath: '../../test/myTest/',
+            expectedPath: '../../test/myTest/MyComponent.js',
+            expectedSpecifier: 'MyExport'
+        });
+    });
+    it('aliased path', ()=>{
+        componentPathTest({
+            baseDir: '/test/myTest',
+            importMapFilePath: '/app/(payload)/importMap.js',
+            payloadComponent: '@components/MyComponent.js#MyExport',
+            expectedImportMapToBaseDirPath: '../../test/myTest/',
+            expectedPath: '@components/MyComponent.js',
+            expectedSpecifier: 'MyExport'
+        });
+    });
+    it('aliased path in PayloadComponent object', ()=>{
+        componentPathTest({
+            baseDir: '/test/',
+            importMapFilePath: '/app/(payload)/importMap.js',
+            payloadComponent: {
+                path: '@components/MyComponent.js'
+            },
+            expectedImportMapToBaseDirPath: '../../test/',
+            expectedPath: '@components/MyComponent.js',
+            expectedSpecifier: 'default'
+        });
+    });
+    it('relative path import starting with slash, going up', ()=>{
+        componentPathTest({
+            baseDir: '/test/myTest',
+            importMapFilePath: '/test/myTest/app/importMap.js',
+            payloadComponent: '/../MyComponent.js#MyExport',
+            expectedImportMapToBaseDirPath: '../',
+            expectedPath: '../../MyComponent.js',
+            expectedSpecifier: 'MyExport'
+        });
+    });
+    it('relative path import starting with dot-slash, going up', ()=>{
+        componentPathTest({
+            baseDir: '/test/myTest',
+            importMapFilePath: '/test/myTest/app/importMap.js',
+            payloadComponent: './../MyComponent.js#MyExport',
+            expectedImportMapToBaseDirPath: '../',
+            expectedPath: '../../MyComponent.js',
+            expectedSpecifier: 'MyExport'
+        });
+    });
+    it('importMap and baseDir in same directory', ()=>{
+        componentPathTest({
+            baseDir: '/test/myTest',
+            importMapFilePath: '/test/myTest/importMap.js',
+            payloadComponent: './MyComponent.js#MyExport',
+            expectedImportMapToBaseDirPath: './',
+            expectedPath: './MyComponent.js',
+            expectedSpecifier: 'MyExport'
+        });
+    });
+    it('baseDir within importMap dir', ()=>{
+        componentPathTest({
+            baseDir: '/test/myTest/components',
+            importMapFilePath: '/test/myTest/importMap.js',
+            payloadComponent: './MyComponent.js#MyExport',
+            expectedImportMapToBaseDirPath: './components/',
+            expectedPath: './components/MyComponent.js',
+            expectedSpecifier: 'MyExport'
+        });
+    });
+});
+
+//# sourceMappingURL=generateImportMap.spec.js.map

package/dist/bin/generateImportMap/generateImportMap.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/bin/generateImportMap/generateImportMap.spec.ts"],"sourcesContent":["import { describe, beforeEach, expect, it, vitest } from 'vitest'\nimport type { PayloadComponent } from '../../index.js'\nimport { addPayloadComponentToImportMap } from './utilities/addPayloadComponentToImportMap.js'\nimport { getImportMapToBaseDirPath } from './utilities/getImportMapToBaseDirPath.js'\n\ndescribe('addPayloadComponentToImportMap', () => {\n  let importMap: Record<string, string>\n  let imports: Record<\n    string,\n    {\n      path: string\n      specifier: string\n    }\n  >\n\n  beforeEach(() => {\n    importMap = {}\n    imports = {}\n    vitest.restoreAllMocks()\n  })\n\n  function componentPathTest({\n    baseDir,\n    importMapFilePath,\n    payloadComponent,\n    expectedPath,\n    expectedSpecifier,\n    expectedImportMapToBaseDirPath,\n  }: {\n    baseDir: string\n    importMapFilePath: string\n    payloadComponent: PayloadComponent\n    expectedPath: string\n    expectedImportMapToBaseDirPath: string\n    expectedSpecifier: string\n  }) {\n    const importMapToBaseDirPath = getImportMapToBaseDirPath({\n      baseDir,\n      importMapPath: importMapFilePath,\n    })\n\n    expect(importMapToBaseDirPath).toBe(expectedImportMapToBaseDirPath)\n\n    const { path, specifier } =\n      addPayloadComponentToImportMap({\n        importMapToBaseDirPath,\n        importMap,\n        imports,\n        payloadComponent,\n      }) ?? {}\n\n    expect(path).toBe(expectedPath)\n    expect(specifier).toBe(expectedSpecifier)\n  }\n\n  it('relative path with import map partially in base dir', () => {\n    componentPathTest({\n      baseDir: '/myPackage/test/myTest',\n      importMapFilePath: '/myPackage/app/(payload)/importMap.js',\n      payloadComponent: './MyComponent.js#MyExport',\n      expectedImportMapToBaseDirPath: '../../test/myTest/',\n      expectedPath: '../../test/myTest/MyComponent.js',\n      expectedSpecifier: 'MyExport',\n    })\n  })\n\n  it('relative path with import map partially in base dir 2', () => {\n    componentPathTest({\n      baseDir: '/myPackage/test/myTest',\n      importMapFilePath: '/myPackage/test/prod/app/(payload)/importMap.js',\n      payloadComponent: {\n        path: './MyComponent.js#MyExport',\n      },\n      expectedImportMapToBaseDirPath: '../../../myTest/',\n      expectedPath: '../../../myTest/MyComponent.js',\n      expectedSpecifier: 'MyExport',\n    })\n  })\n\n  it('relative path with import map partially in base dir 3', () => {\n    componentPathTest({\n      baseDir: '/myPackage/test/myTest',\n      importMapFilePath: '/myPackage/test/prod/app/(payload)/importMap.js',\n      payloadComponent: {\n        path: '../otherTest/MyComponent.js',\n        exportName: 'MyExport',\n      },\n      expectedImportMapToBaseDirPath: '../../../myTest/',\n      expectedPath: '../../../otherTest/MyComponent.js',\n      expectedSpecifier: 'MyExport',\n    })\n  })\n\n  it('relative path with import map within base dir', () => {\n    componentPathTest({\n      baseDir: '/myPackage/test/myTest',\n      importMapFilePath: '/myPackage/test/myTest/prod/app/(payload)/importMap.js',\n      payloadComponent: './MyComponent.js#MyExport',\n      expectedImportMapToBaseDirPath: '../../../',\n      expectedPath: '../../../MyComponent.js',\n      expectedSpecifier: 'MyExport',\n    })\n  })\n\n  it('relative path with import map not in base dir', () => {\n    componentPathTest({\n      baseDir: '/test/myTest',\n      importMapFilePath: '/app/(payload)/importMap.js',\n      payloadComponent: './MyComponent.js#MyExport',\n      expectedImportMapToBaseDirPath: '../../test/myTest/',\n      expectedPath: '../../test/myTest/MyComponent.js',\n      expectedSpecifier: 'MyExport',\n    })\n  })\n\n  it('relative path with import map not in base dir 2', () => {\n    componentPathTest({\n      baseDir: '/test/myTest',\n      importMapFilePath: '/app/(payload)/importMap.js',\n      payloadComponent: '../myOtherTest/MyComponent.js#MyExport',\n      expectedImportMapToBaseDirPath: '../../test/myTest/',\n      expectedPath: '../../test/myOtherTest/MyComponent.js',\n      expectedSpecifier: 'MyExport',\n    })\n  })\n\n  it('relative path with import map not in base dir, baseDir ending with slash', () => {\n    componentPathTest({\n      baseDir: '/test/myTest/',\n      importMapFilePath: '/app/(payload)/importMap.js',\n      payloadComponent: './MyComponent.js#MyExport',\n      expectedImportMapToBaseDirPath: '../../test/myTest/',\n      expectedPath: '../../test/myTest/MyComponent.js',\n      expectedSpecifier: 'MyExport',\n    })\n  })\n\n  it('relative path with import map not in base dir, component starting with slash', () => {\n    componentPathTest({\n      baseDir: '/test/myTest',\n      importMapFilePath: '/app/(payload)/importMap.js',\n      payloadComponent: '/MyComponent.js#MyExport',\n      expectedImportMapToBaseDirPath: '../../test/myTest/',\n      expectedPath: '../../test/myTest/MyComponent.js',\n      expectedSpecifier: 'MyExport',\n    })\n  })\n\n  it('aliased path', () => {\n    componentPathTest({\n      baseDir: '/test/myTest',\n      importMapFilePath: '/app/(payload)/importMap.js',\n      payloadComponent: '@components/MyComponent.js#MyExport',\n      expectedImportMapToBaseDirPath: '../../test/myTest/',\n      expectedPath: '@components/MyComponent.js',\n      expectedSpecifier: 'MyExport',\n    })\n  })\n  it('aliased path in PayloadComponent object', () => {\n    componentPathTest({\n      baseDir: '/test/',\n      importMapFilePath: '/app/(payload)/importMap.js',\n      payloadComponent: {\n        path: '@components/MyComponent.js',\n      },\n      expectedImportMapToBaseDirPath: '../../test/',\n      expectedPath: '@components/MyComponent.js',\n      expectedSpecifier: 'default',\n    })\n  })\n\n  it('relative path import starting with slash, going up', () => {\n    componentPathTest({\n      baseDir: '/test/myTest',\n      importMapFilePath: '/test/myTest/app/importMap.js',\n      payloadComponent: '/../MyComponent.js#MyExport',\n      expectedImportMapToBaseDirPath: '../',\n      expectedPath: '../../MyComponent.js',\n      expectedSpecifier: 'MyExport',\n    })\n  })\n\n  it('relative path import starting with dot-slash, going up', () => {\n    componentPathTest({\n      baseDir: '/test/myTest',\n      importMapFilePath: '/test/myTest/app/importMap.js',\n      payloadComponent: './../MyComponent.js#MyExport',\n      expectedImportMapToBaseDirPath: '../',\n      expectedPath: '../../MyComponent.js',\n      expectedSpecifier: 'MyExport',\n    })\n  })\n\n  it('importMap and baseDir in same directory', () => {\n    componentPathTest({\n      baseDir: '/test/myTest',\n      importMapFilePath: '/test/myTest/importMap.js',\n      payloadComponent: './MyComponent.js#MyExport',\n      expectedImportMapToBaseDirPath: './',\n      expectedPath: './MyComponent.js',\n      expectedSpecifier: 'MyExport',\n    })\n  })\n\n  it('baseDir within importMap dir', () => {\n    componentPathTest({\n      baseDir: '/test/myTest/components',\n      importMapFilePath: '/test/myTest/importMap.js',\n      payloadComponent: './MyComponent.js#MyExport',\n      expectedImportMapToBaseDirPath: './components/',\n      expectedPath: './components/MyComponent.js',\n      expectedSpecifier: 'MyExport',\n    })\n  })\n})\n"],"names":["describe","beforeEach","expect","it","vitest","addPayloadComponentToImportMap","getImportMapToBaseDirPath","importMap","imports","restoreAllMocks","componentPathTest","baseDir","importMapFilePath","payloadComponent","expectedPath","expectedSpecifier","expectedImportMapToBaseDirPath","importMapToBaseDirPath","importMapPath","toBe","path","specifier","exportName"],"mappings":"AAAA,SAASA,QAAQ,EAAEC,UAAU,EAAEC,MAAM,EAAEC,EAAE,EAAEC,MAAM,QAAQ,SAAQ;AAEjE,SAASC,8BAA8B,QAAQ,gDAA+C;AAC9F,SAASC,yBAAyB,QAAQ,2CAA0C;AAEpFN,SAAS,kCAAkC;IACzC,IAAIO;IACJ,IAAIC;IAQJP,WAAW;QACTM,YAAY,CAAC;QACbC,UAAU,CAAC;QACXJ,OAAOK,eAAe;IACxB;IAEA,SAASC,kBAAkB,EACzBC,OAAO,EACPC,iBAAiB,EACjBC,gBAAgB,EAChBC,YAAY,EACZC,iBAAiB,EACjBC,8BAA8B,EAQ/B;QACC,MAAMC,yBAAyBX,0BAA0B;YACvDK;YACAO,eAAeN;QACjB;QAEAV,OAAOe,wBAAwBE,IAAI,CAACH;QAEpC,MAAM,EAAEI,IAAI,EAAEC,SAAS,EAAE,GACvBhB,+BAA+B;YAC7BY;YACAV;YACAC;YACAK;QACF,MAAM,CAAC;QAETX,OAAOkB,MAAMD,IAAI,CAACL;QAClBZ,OAAOmB,WAAWF,IAAI,CAACJ;IACzB;IAEAZ,GAAG,uDAAuD;QACxDO,kBAAkB;YAChBC,SAAS;YACTC,mBAAmB;YACnBC,kBAAkB;YAClBG,gCAAgC;YAChCF,cAAc;YACdC,mBAAmB;QACrB;IACF;IAEAZ,GAAG,yDAAyD;QAC1DO,kBAAkB;YAChBC,SAAS;YACTC,mBAAmB;YACnBC,kBAAkB;gBAChBO,MAAM;YACR;YACAJ,gCAAgC;YAChCF,cAAc;YACdC,mBAAmB;QACrB;IACF;IAEAZ,GAAG,yDAAyD;QAC1DO,kBAAkB;YAChBC,SAAS;YACTC,mBAAmB;YACnBC,kBAAkB;gBAChBO,MAAM;gBACNE,YAAY;YACd;YACAN,gCAAgC;YAChCF,cAAc;YACdC,mBAAmB;QACrB;IACF;IAEAZ,GAAG,iDAAiD;QAClDO,kBAAkB;YAChBC,SAAS;YACTC,mBAAmB;YACnBC,kBAAkB;YAClBG,gCAAgC;YAChCF,cAAc;YACdC,mBAAmB;QACrB;IACF;IAEAZ,GAAG,iDAAiD;QAClDO,kBAAkB;YAChBC,SAAS;YACTC,mBAAmB;YACnBC,kBAAkB;YAClBG,gCAAgC;YAChCF,cAAc;YACdC,mBAAmB;QACrB;IACF;IAEAZ,GAAG,mDAAmD;QACpDO,kBAAkB;YAChBC,SAAS;YACTC,mBAAmB;YACnBC,kBAAkB;YAClBG,gCAAgC;YAChCF,cAAc;YACdC,mBAAmB;QACrB;IACF;IAEAZ,GAAG,4EAA4E;QAC7EO,kBAAkB;YAChBC,SAAS;YACTC,mBAAmB;YACnBC,kBAAkB;YAClBG,gCAAgC;YAChCF,cAAc;YACdC,mBAAmB;QACrB;IACF;IAEAZ,GAAG,gFAAgF;QACjFO,kBAAkB;YAChBC,SAAS;YACTC,mBAAmB;YACnBC,kBAAkB;YAClBG,gCAAgC;YAChCF,cAAc;YACdC,mBAAmB;QACrB;IACF;IAEAZ,GAAG,gBAAgB;QACjBO,kBAAkB;YAChBC,SAAS;YACTC,mBAAmB;YACnBC,kBAAkB;YAClBG,gCAAgC;YAChCF,cAAc;YACdC,mBAAmB;QACrB;IACF;IACAZ,GAAG,2CAA2C;QAC5CO,kBAAkB;YAChBC,SAAS;YACTC,mBAAmB;YACnBC,kBAAkB;gBAChBO,MAAM;YACR;YACAJ,gCAAgC;YAChCF,cAAc;YACdC,mBAAmB;QACrB;IACF;IAEAZ,GAAG,sDAAsD;QACvDO,kBAAkB;YAChBC,SAAS;YACTC,mBAAmB;YACnBC,kBAAkB;YAClBG,gCAAgC;YAChCF,cAAc;YACdC,mBAAmB;QACrB;IACF;IAEAZ,GAAG,0DAA0D;QAC3DO,kBAAkB;YAChBC,SAAS;YACTC,mBAAmB;YACnBC,kBAAkB;YAClBG,gCAAgC;YAChCF,cAAc;YACdC,mBAAmB;QACrB;IACF;IAEAZ,GAAG,2CAA2C;QAC5CO,kBAAkB;YAChBC,SAAS;YACTC,mBAAmB;YACnBC,kBAAkB;YAClBG,gCAAgC;YAChCF,cAAc;YACdC,mBAAmB;QACrB;IACF;IAEAZ,GAAG,gCAAgC;QACjCO,kBAAkB;YAChBC,SAAS;YACTC,mBAAmB;YACnBC,kBAAkB;YAClBG,gCAAgC;YAChCF,cAAc;YACdC,mBAAmB;QACrB;IACF;AACF"}

package/dist/bin/generateImportMap/index.d.ts

@@ -0,0 +1,44 @@
+import type { PayloadComponent, SanitizedConfig } from '../../config/types.js';
+type ImportIdentifier = string;
+type ImportSpecifier = string;
+type ImportPath = string;
+type UserImportPath = string;
+/**
+ * Import Map before being written to the file. Only contains all paths
+ */
+export type InternalImportMap = {
+    [path: UserImportPath]: ImportIdentifier;
+};
+/**
+ * Imports of the import map.
+ */
+export type Imports = {
+    [identifier: ImportIdentifier]: {
+        path: ImportPath;
+        specifier: ImportSpecifier;
+    };
+};
+/**
+ * Import Map after being imported from the actual import map. Contains all the actual imported components
+ */
+export type ImportMap = {
+    [path: UserImportPath]: any;
+};
+export type AddToImportMap = (payloadComponent?: PayloadComponent | PayloadComponent[]) => void;
+export declare function generateImportMap(config: SanitizedConfig, options?: {
+    force?: boolean; /**
+     * If true, will not throw an error if the import map file path cannot be resolved
+    Instead, it will return silently.
+     */
+    ignoreResolveError?: boolean;
+    log: boolean;
+}): Promise<void>;
+export declare function writeImportMap({ componentMap, force, importMap, importMapFilePath, log, }: {
+    componentMap: InternalImportMap;
+    force?: boolean;
+    importMap: Imports;
+    importMapFilePath: string;
+    log?: boolean;
+}): Promise<void>;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/bin/generateImportMap/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/bin/generateImportMap/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAO9E,KAAK,gBAAgB,GAAG,MAAM,CAAA;AAC9B,KAAK,eAAe,GAAG,MAAM,CAAA;AAC7B,KAAK,UAAU,GAAG,MAAM,CAAA;AACxB,KAAK,cAAc,GAAG,MAAM,CAAA;AAE5B;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,CAAC,IAAI,EAAE,cAAc,GAAG,gBAAgB,CAAA;CACzC,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,CAAC,UAAU,EAAE,gBAAgB,GAAG;QAC9B,IAAI,EAAE,UAAU,CAAA;QAChB,SAAS,EAAE,eAAe,CAAA;KAC3B,CAAA;CACF,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,CAAC,IAAI,EAAE,cAAc,GAAG,GAAG,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,cAAc,GAAG,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,gBAAgB,EAAE,KAAK,IAAI,CAAA;AAE/F,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,eAAe,EACvB,OAAO,CAAC,EAAE;IACR,KAAK,CAAC,EAAE,OAAO,CAAA,CAAC;;;OAGb;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,GAAG,EAAE,OAAO,CAAA;CACb,GACA,OAAO,CAAC,IAAI,CAAC,CA8Ef;AAED,wBAAsB,cAAc,CAAC,EACnC,YAAY,EACZ,KAAK,EACL,SAAS,EACT,iBAAiB,EACjB,GAAG,GACJ,EAAE;IACD,YAAY,EAAE,iBAAiB,CAAA;IAC/B,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,SAAS,EAAE,OAAO,CAAA;IAClB,iBAAiB,EAAE,MAAM,CAAA;IACzB,GAAG,CAAC,EAAE,OAAO,CAAA;CACd,iBAmCA"}