@clicktap/state 0.13.18 → 0.14.0

package/auth/AuthProvider.d.ts

@@ -5,156 +5,108 @@ export interface AuthContextType {
     authActor: Actor<typeof authMachine>;
     isLoggedIn: boolean;
 }
-export declare const AuthContext: import("react").Context<Actor<import("xstate").StateMachine<import("./auth").AuthMachineContext, import("./auth").RefreshTokenEvent | import("./auth").LoginEvent | import("./auth").LogoutEvent | import("./auth").ClearErrorsEvent | import("xstate").DoneActorEvent<import("./auth").AuthenticateSuccessEvent> | import("xstate").DoneActorEvent<import("./auth").RefreshTokenSuccessEvent>, {
-    [x: string]: import("xstate").ActorRef<import("xstate").PromiseSnapshot<{
-        type: string;
-        accessToken: string;
-    }, {
-        context: import("./auth").AuthMachineContext;
-    }>, {
+export declare const AuthContext: import("react").Context<Actor<import("xstate").StateMachine<import("./types").AuthMachineContext, import("./types").RefreshTokenEvent | import("./types").LoginEvent | import("./types").LogoutEvent | import("./types").ClearErrorsEvent | import("xstate").DoneActorEvent<import("./types").AuthenticateSuccessEvent> | import("xstate").DoneActorEvent<import("./types").RefreshTokenSuccessEvent>, {
+    [x: string]: import("xstate").ActorRef<import("xstate").PromiseSnapshot<import("./types").AuthenticateSuccessEvent, import("./actors").AuthenticateInput>, {
         [k: string]: unknown;
         type: string;
-    }, import("xstate").EventObject> | import("xstate").ActorRef<import("xstate").PromiseSnapshot<{
-        type: string;
-        accessToken: string;
-    }, {
-        context: import("./auth").AuthMachineContext;
-        username: string;
-        password: string;
-    }>, {
+    }, import("xstate").EventObject> | import("xstate").ActorRef<import("xstate").PromiseSnapshot<import("./types").RefreshTokenSuccessEvent, import("./actors").RefreshTokenInput>, {
         [k: string]: unknown;
         type: string;
-    }, import("xstate").EventObject> | import("xstate").ActorRef<import("xstate").PromiseSnapshot<{
-        type: string;
-    }, {
-        context: import("./auth").AuthMachineContext;
-    }>, {
+    }, import("xstate").EventObject> | import("xstate").ActorRef<import("xstate").PromiseSnapshot<import("./types").UnauthenticateSuccessEvent, import("./actors").UnauthenticateInput>, {
         [k: string]: unknown;
         type: string;
     }, import("xstate").EventObject> | undefined;
 }, import("xstate").Values<{
-    refreshAccessToken: {
-        src: "refreshAccessToken";
-        logic: import("xstate").PromiseActorLogic<{
-            type: string;
-            accessToken: string;
-        }, {
-            context: import("./auth").AuthMachineContext;
-        }>;
-        id: string | undefined;
-    };
     authenticate: {
         src: "authenticate";
-        logic: import("xstate").PromiseActorLogic<{
-            type: string;
-            accessToken: string;
-        }, {
-            context: import("./auth").AuthMachineContext;
-            username: string;
-            password: string;
-        }>;
+        logic: import("xstate").PromiseActorLogic<import("./types").AuthenticateSuccessEvent, import("./actors").AuthenticateInput>;
+        id: string | undefined;
+    };
+    refreshAccessToken: {
+        src: "refreshAccessToken";
+        logic: import("xstate").PromiseActorLogic<import("./types").RefreshTokenSuccessEvent, import("./actors").RefreshTokenInput>;
         id: string | undefined;
     };
     unauthenticate: {
         src: "unauthenticate";
-        logic: import("xstate").PromiseActorLogic<{
-            type: string;
-        }, {
-            context: import("./auth").AuthMachineContext;
-        }>;
+        logic: import("xstate").PromiseActorLogic<import("./types").UnauthenticateSuccessEvent, import("./actors").UnauthenticateInput>;
         id: string | undefined;
     };
 }>, import("xstate").Values<{
-    setUserContext: {
-        type: "setUserContext";
+    addError: {
+        type: "addError";
         params: import("xstate").NonReducibleUnknown;
     };
-    unsetUserContext: {
-        type: "unsetUserContext";
+    clearErrors: {
+        type: "clearErrors";
         params: import("xstate").NonReducibleUnknown;
     };
     setAccessToken: {
         type: "setAccessToken";
         params: import("xstate").NonReducibleUnknown;
     };
-    unsetRefreshToken: {
-        type: "unsetRefreshToken";
-        params: import("xstate").NonReducibleUnknown;
-    };
     setIgnoreRefreshToken: {
         type: "setIgnoreRefreshToken";
         params: import("xstate").NonReducibleUnknown;
     };
-    addError: {
-        type: "addError";
+    setUserContext: {
+        type: "setUserContext";
         params: import("xstate").NonReducibleUnknown;
     };
-    clearErrors: {
-        type: "clearErrors";
+    unsetRefreshToken: {
+        type: "unsetRefreshToken";
+        params: import("xstate").NonReducibleUnknown;
+    };
+    unsetUserContext: {
+        type: "unsetUserContext";
         params: import("xstate").NonReducibleUnknown;
     };
 }>, never, never, "refreshing" | "authenticating" | "loggedIn" | "loggedOut" | "unauthenticating", string, {
-    initialContext: Partial<import("./auth").AuthMachineContext>;
+    initialContext: Partial<import("./types").AuthMachineContext>;
     initialState?: string | undefined;
-}, import("xstate").NonReducibleUnknown, import("xstate").EventObject, import("xstate").MetaObject, import("xstate").ResolveTypegenMeta<import("xstate").TypegenDisabled, import("./auth").RefreshTokenEvent | import("./auth").LoginEvent | import("./auth").LogoutEvent | import("./auth").ClearErrorsEvent | import("xstate").DoneActorEvent<import("./auth").AuthenticateSuccessEvent> | import("xstate").DoneActorEvent<import("./auth").RefreshTokenSuccessEvent>, import("xstate").Values<{
-    refreshAccessToken: {
-        src: "refreshAccessToken";
-        logic: import("xstate").PromiseActorLogic<{
-            type: string;
-            accessToken: string;
-        }, {
-            context: import("./auth").AuthMachineContext;
-        }>;
-        id: string | undefined;
-    };
+}, import("xstate").NonReducibleUnknown, import("xstate").EventObject, import("xstate").MetaObject, import("xstate").ResolveTypegenMeta<import("xstate").TypegenDisabled, import("./types").RefreshTokenEvent | import("./types").LoginEvent | import("./types").LogoutEvent | import("./types").ClearErrorsEvent | import("xstate").DoneActorEvent<import("./types").AuthenticateSuccessEvent> | import("xstate").DoneActorEvent<import("./types").RefreshTokenSuccessEvent>, import("xstate").Values<{
     authenticate: {
         src: "authenticate";
-        logic: import("xstate").PromiseActorLogic<{
-            type: string;
-            accessToken: string;
-        }, {
-            context: import("./auth").AuthMachineContext;
-            username: string;
-            password: string;
-        }>;
+        logic: import("xstate").PromiseActorLogic<import("./types").AuthenticateSuccessEvent, import("./actors").AuthenticateInput>;
+        id: string | undefined;
+    };
+    refreshAccessToken: {
+        src: "refreshAccessToken";
+        logic: import("xstate").PromiseActorLogic<import("./types").RefreshTokenSuccessEvent, import("./actors").RefreshTokenInput>;
         id: string | undefined;
     };
     unauthenticate: {
         src: "unauthenticate";
-        logic: import("xstate").PromiseActorLogic<{
-            type: string;
-        }, {
-            context: import("./auth").AuthMachineContext;
-        }>;
+        logic: import("xstate").PromiseActorLogic<import("./types").UnauthenticateSuccessEvent, import("./actors").UnauthenticateInput>;
         id: string | undefined;
     };
 }>, import("xstate").Values<{
-    setUserContext: {
-        type: "setUserContext";
+    addError: {
+        type: "addError";
         params: import("xstate").NonReducibleUnknown;
     };
-    unsetUserContext: {
-        type: "unsetUserContext";
+    clearErrors: {
+        type: "clearErrors";
         params: import("xstate").NonReducibleUnknown;
     };
     setAccessToken: {
         type: "setAccessToken";
         params: import("xstate").NonReducibleUnknown;
     };
-    unsetRefreshToken: {
-        type: "unsetRefreshToken";
-        params: import("xstate").NonReducibleUnknown;
-    };
     setIgnoreRefreshToken: {
         type: "setIgnoreRefreshToken";
         params: import("xstate").NonReducibleUnknown;
     };
-    addError: {
-        type: "addError";
+    setUserContext: {
+        type: "setUserContext";
         params: import("xstate").NonReducibleUnknown;
     };
-    clearErrors: {
-        type: "clearErrors";
+    unsetRefreshToken: {
+        type: "unsetRefreshToken";
+        params: import("xstate").NonReducibleUnknown;
+    };
+    unsetUserContext: {
+        type: "unsetUserContext";
         params: import("xstate").NonReducibleUnknown;
     };
 }>, never, never, string, import("xstate").EventObject>>>>;
@@ -174,156 +126,108 @@ type AuthOptions = {
  * @todo should probably update signature to pass Partial<AuthContext> and
  * Options, endpoints should probably be moved into context
  */
-export declare const getAuth: (refreshToken?: string, options?: AuthOptions) => Promise<Actor<import("xstate").StateMachine<import("./auth").AuthMachineContext, import("./auth").RefreshTokenEvent | import("./auth").LoginEvent | import("./auth").LogoutEvent | import("./auth").ClearErrorsEvent | import("xstate").DoneActorEvent<import("./auth").AuthenticateSuccessEvent> | import("xstate").DoneActorEvent<import("./auth").RefreshTokenSuccessEvent>, {
-    [x: string]: import("xstate").ActorRef<import("xstate").PromiseSnapshot<{
-        type: string;
-        accessToken: string;
-    }, {
-        context: import("./auth").AuthMachineContext;
-    }>, {
+export declare const getAuth: (refreshToken?: string, options?: AuthOptions) => Promise<Actor<import("xstate").StateMachine<import("./types").AuthMachineContext, import("./types").RefreshTokenEvent | import("./types").LoginEvent | import("./types").LogoutEvent | import("./types").ClearErrorsEvent | import("xstate").DoneActorEvent<import("./types").AuthenticateSuccessEvent> | import("xstate").DoneActorEvent<import("./types").RefreshTokenSuccessEvent>, {
+    [x: string]: import("xstate").ActorRef<import("xstate").PromiseSnapshot<import("./types").AuthenticateSuccessEvent, import("./actors").AuthenticateInput>, {
         [k: string]: unknown;
         type: string;
-    }, import("xstate").EventObject> | import("xstate").ActorRef<import("xstate").PromiseSnapshot<{
-        type: string;
-        accessToken: string;
-    }, {
-        context: import("./auth").AuthMachineContext;
-        username: string;
-        password: string;
-    }>, {
+    }, import("xstate").EventObject> | import("xstate").ActorRef<import("xstate").PromiseSnapshot<import("./types").RefreshTokenSuccessEvent, import("./actors").RefreshTokenInput>, {
         [k: string]: unknown;
         type: string;
-    }, import("xstate").EventObject> | import("xstate").ActorRef<import("xstate").PromiseSnapshot<{
-        type: string;
-    }, {
-        context: import("./auth").AuthMachineContext;
-    }>, {
+    }, import("xstate").EventObject> | import("xstate").ActorRef<import("xstate").PromiseSnapshot<import("./types").UnauthenticateSuccessEvent, import("./actors").UnauthenticateInput>, {
         [k: string]: unknown;
         type: string;
     }, import("xstate").EventObject> | undefined;
 }, import("xstate").Values<{
-    refreshAccessToken: {
-        src: "refreshAccessToken";
-        logic: import("xstate").PromiseActorLogic<{
-            type: string;
-            accessToken: string;
-        }, {
-            context: import("./auth").AuthMachineContext;
-        }>;
-        id: string | undefined;
-    };
     authenticate: {
         src: "authenticate";
-        logic: import("xstate").PromiseActorLogic<{
-            type: string;
-            accessToken: string;
-        }, {
-            context: import("./auth").AuthMachineContext;
-            username: string;
-            password: string;
-        }>;
+        logic: import("xstate").PromiseActorLogic<import("./types").AuthenticateSuccessEvent, import("./actors").AuthenticateInput>;
+        id: string | undefined;
+    };
+    refreshAccessToken: {
+        src: "refreshAccessToken";
+        logic: import("xstate").PromiseActorLogic<import("./types").RefreshTokenSuccessEvent, import("./actors").RefreshTokenInput>;
         id: string | undefined;
     };
     unauthenticate: {
         src: "unauthenticate";
-        logic: import("xstate").PromiseActorLogic<{
-            type: string;
-        }, {
-            context: import("./auth").AuthMachineContext;
-        }>;
+        logic: import("xstate").PromiseActorLogic<import("./types").UnauthenticateSuccessEvent, import("./actors").UnauthenticateInput>;
         id: string | undefined;
     };
 }>, import("xstate").Values<{
-    setUserContext: {
-        type: "setUserContext";
+    addError: {
+        type: "addError";
         params: import("xstate").NonReducibleUnknown;
     };
-    unsetUserContext: {
-        type: "unsetUserContext";
+    clearErrors: {
+        type: "clearErrors";
         params: import("xstate").NonReducibleUnknown;
     };
     setAccessToken: {
         type: "setAccessToken";
         params: import("xstate").NonReducibleUnknown;
     };
-    unsetRefreshToken: {
-        type: "unsetRefreshToken";
-        params: import("xstate").NonReducibleUnknown;
-    };
     setIgnoreRefreshToken: {
         type: "setIgnoreRefreshToken";
         params: import("xstate").NonReducibleUnknown;
     };
-    addError: {
-        type: "addError";
+    setUserContext: {
+        type: "setUserContext";
         params: import("xstate").NonReducibleUnknown;
     };
-    clearErrors: {
-        type: "clearErrors";
+    unsetRefreshToken: {
+        type: "unsetRefreshToken";
+        params: import("xstate").NonReducibleUnknown;
+    };
+    unsetUserContext: {
+        type: "unsetUserContext";
         params: import("xstate").NonReducibleUnknown;
     };
 }>, never, never, "refreshing" | "authenticating" | "loggedIn" | "loggedOut" | "unauthenticating", string, {
-    initialContext: Partial<import("./auth").AuthMachineContext>;
+    initialContext: Partial<import("./types").AuthMachineContext>;
     initialState?: string | undefined;
-}, import("xstate").NonReducibleUnknown, import("xstate").EventObject, import("xstate").MetaObject, import("xstate").ResolveTypegenMeta<import("xstate").TypegenDisabled, import("./auth").RefreshTokenEvent | import("./auth").LoginEvent | import("./auth").LogoutEvent | import("./auth").ClearErrorsEvent | import("xstate").DoneActorEvent<import("./auth").AuthenticateSuccessEvent> | import("xstate").DoneActorEvent<import("./auth").RefreshTokenSuccessEvent>, import("xstate").Values<{
-    refreshAccessToken: {
-        src: "refreshAccessToken";
-        logic: import("xstate").PromiseActorLogic<{
-            type: string;
-            accessToken: string;
-        }, {
-            context: import("./auth").AuthMachineContext;
-        }>;
-        id: string | undefined;
-    };
+}, import("xstate").NonReducibleUnknown, import("xstate").EventObject, import("xstate").MetaObject, import("xstate").ResolveTypegenMeta<import("xstate").TypegenDisabled, import("./types").RefreshTokenEvent | import("./types").LoginEvent | import("./types").LogoutEvent | import("./types").ClearErrorsEvent | import("xstate").DoneActorEvent<import("./types").AuthenticateSuccessEvent> | import("xstate").DoneActorEvent<import("./types").RefreshTokenSuccessEvent>, import("xstate").Values<{
     authenticate: {
         src: "authenticate";
-        logic: import("xstate").PromiseActorLogic<{
-            type: string;
-            accessToken: string;
-        }, {
-            context: import("./auth").AuthMachineContext;
-            username: string;
-            password: string;
-        }>;
+        logic: import("xstate").PromiseActorLogic<import("./types").AuthenticateSuccessEvent, import("./actors").AuthenticateInput>;
+        id: string | undefined;
+    };
+    refreshAccessToken: {
+        src: "refreshAccessToken";
+        logic: import("xstate").PromiseActorLogic<import("./types").RefreshTokenSuccessEvent, import("./actors").RefreshTokenInput>;
         id: string | undefined;
     };
     unauthenticate: {
         src: "unauthenticate";
-        logic: import("xstate").PromiseActorLogic<{
-            type: string;
-        }, {
-            context: import("./auth").AuthMachineContext;
-        }>;
+        logic: import("xstate").PromiseActorLogic<import("./types").UnauthenticateSuccessEvent, import("./actors").UnauthenticateInput>;
         id: string | undefined;
     };
 }>, import("xstate").Values<{
-    setUserContext: {
-        type: "setUserContext";
+    addError: {
+        type: "addError";
         params: import("xstate").NonReducibleUnknown;
     };
-    unsetUserContext: {
-        type: "unsetUserContext";
+    clearErrors: {
+        type: "clearErrors";
         params: import("xstate").NonReducibleUnknown;
     };
     setAccessToken: {
         type: "setAccessToken";
         params: import("xstate").NonReducibleUnknown;
     };
-    unsetRefreshToken: {
-        type: "unsetRefreshToken";
-        params: import("xstate").NonReducibleUnknown;
-    };
     setIgnoreRefreshToken: {
         type: "setIgnoreRefreshToken";
         params: import("xstate").NonReducibleUnknown;
     };
-    addError: {
-        type: "addError";
+    setUserContext: {
+        type: "setUserContext";
         params: import("xstate").NonReducibleUnknown;
     };
-    clearErrors: {
-        type: "clearErrors";
+    unsetRefreshToken: {
+        type: "unsetRefreshToken";
+        params: import("xstate").NonReducibleUnknown;
+    };
+    unsetUserContext: {
+        type: "unsetUserContext";
         params: import("xstate").NonReducibleUnknown;
     };
 }>, never, never, string, import("xstate").EventObject>>>>;

package/auth/actions/addError.d.ts

@@ -0,0 +1,8 @@
+import { AuthMachineContext, AuthMachineEvents } from '../types';
+export declare function addError({ context, event, }: {
+    context: AuthMachineContext;
+    event: AuthMachineEvents;
+}): AuthMachineContext | {
+    errors: string[];
+};
+export default addError;

package/auth/actions/clearErrors.d.ts

@@ -0,0 +1,5 @@
+/** @todo should we assertEvent here? */
+export declare function clearErrors(): {
+    errors: never[];
+};
+export default clearErrors;

package/auth/actions/index.d.ts

@@ -0,0 +1,7 @@
+export * from './addError';
+export * from './clearErrors';
+export * from './setAccessToken';
+export * from './setIgnoreRefreshToken';
+export * from './setUserContext';
+export * from './unsetRefreshToken';
+export * from './unsetUserContext';

package/auth/actions/setAccessToken.d.ts

@@ -0,0 +1,9 @@
+import { AuthMachineContext, AuthMachineEvents } from '../types';
+export declare function setAccessToken({ context, event, }: {
+    context: AuthMachineContext;
+    event: AuthMachineEvents;
+}): AuthMachineContext | {
+    accessToken: string;
+    ignoreRefreshToken: boolean;
+};
+export default setAccessToken;

package/auth/actions/setIgnoreRefreshToken.d.ts

@@ -0,0 +1,4 @@
+export declare function setIgnoreRefreshToken(): {
+    ignoreRefreshToken: boolean;
+};
+export default setIgnoreRefreshToken;

package/auth/actions/setUserContext.d.ts

@@ -0,0 +1,9 @@
+import { AuthMachineContext, AuthMachineEvents } from '../types';
+export declare function setUserContext({ context, event, }: {
+    context: AuthMachineContext;
+    event: AuthMachineEvents;
+}): AuthMachineContext | {
+    accessToken: string;
+    ignoreRefreshToken: boolean;
+};
+export default setUserContext;

package/auth/actions/unsetRefreshToken.d.ts

@@ -0,0 +1,4 @@
+export declare function unsetRefreshToken(): {
+    refreshToken: string;
+};
+export default unsetRefreshToken;

package/auth/actions/unsetUserContext.d.ts

@@ -0,0 +1,8 @@
+/** @todo should we assertEvent here? */
+export declare function unsetUserContext(): {
+    user: null;
+    accessToken: string;
+    refreshToken: string;
+    ignoreRefreshToken: boolean;
+};
+export default unsetUserContext;

package/auth/actors/authenticate.d.ts

@@ -0,0 +1,16 @@
+import { AuthenticateSuccessEvent, AuthMachineContext } from '../types';
+export type AuthenticateInput = {
+    endpoint: {
+        client: AuthMachineContext['endpoints']['login'];
+    };
+    password: string;
+    username: string;
+};
+export type AuthenticateResponse = {
+    success: boolean;
+    message?: string;
+    accessToken?: string;
+};
+/** @todo pass locale for auth server? */
+export declare const authenticate: import("xstate").PromiseActorLogic<AuthenticateSuccessEvent, AuthenticateInput>;
+export default authenticate;

package/auth/actors/index.d.ts

@@ -0,0 +1,3 @@
+export * from './authenticate';
+export * from './refreshAccessToken';
+export * from './unauthenticate';

package/auth/actors/refreshAccessToken.d.ts

@@ -0,0 +1,18 @@
+import { RefreshTokenSuccessEvent, AuthMachineContext } from '../types';
+export type RefreshTokenInput = {
+    refreshToken: AuthMachineContext['refreshToken'];
+    endpoint: {
+        client: AuthMachineContext['endpoints']['refresh'];
+        server: AuthMachineContext['endpoints']['ssrRefresh'];
+    };
+};
+export type RefreshTokenResponse = {
+    accessToken?: string;
+};
+export type RefreshTokenOutput = {
+    type: string;
+    accessToken: string;
+};
+/** @todo pass locale for auth server? */
+export declare const refreshAccessToken: import("xstate").PromiseActorLogic<RefreshTokenSuccessEvent, RefreshTokenInput>;
+export default refreshAccessToken;

package/auth/actors/unauthenticate.d.ts

@@ -0,0 +1,14 @@
+import { UnauthenticateSuccessEvent, AuthMachineContext } from '../types';
+export type UnauthenticateInput = {
+    endpoint: {
+        client: AuthMachineContext['endpoints']['logout'];
+    };
+};
+export type UnauthenticateResponse = {
+    success: boolean;
+    message?: string;
+    accessToken?: string;
+};
+/** @todo pass locale for auth server? */
+export declare const unauthenticate: import("xstate").PromiseActorLogic<UnauthenticateSuccessEvent, UnauthenticateInput>;
+export default unauthenticate;