@clicktap/state 0.16.2 → 0.16.4

package/__mocks__/nanoid.d.ts

@@ -0,0 +1,7 @@
+export declare const nanoid: (_size?: number) => string;
+export declare const customAlphabet: (_alphabet: string, _defaultSize?: number) => (_size?: number) => string;
+declare const _default: {
+    nanoid: (_size?: number) => string;
+    customAlphabet: (_alphabet: string, _defaultSize?: number) => (_size?: number) => string;
+};
+export default _default;

package/auth/AuthProvider.d.ts

@@ -0,0 +1,133 @@
+import { ReactNode } from 'react';
+import { Actor, InspectionEvent, Observer } from 'xstate';
+import { authMachine } from './auth';
+export interface AuthContextType {
+    authActor: Actor<typeof authMachine>;
+    isLoggedIn: boolean;
+}
+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('./types').RestoreEvent | import('xstate').DoneActorEvent<import('./types').AuthenticateSuccessEvent, string> | import('xstate').DoneActorEvent<import('./types').RefreshTokenSuccessEvent, string>, {
+    [x: string]: import('xstate').ActorRefFromLogic<import('xstate').PromiseActorLogic<import('./types').AuthenticateSuccessEvent, import('./actors').AuthenticateInput, import('xstate').EventObject>> | import('xstate').ActorRefFromLogic<import('xstate').PromiseActorLogic<import('./types').RefreshTokenSuccessEvent, import('./actors').RefreshTokenInput, import('xstate').EventObject>> | import('xstate').ActorRefFromLogic<import('xstate').PromiseActorLogic<import('./types').UnauthenticateSuccessEvent, import('./actors').UnauthenticateInput, import('xstate').EventObject>> | undefined;
+}, {
+    src: "authenticate";
+    logic: import('xstate').PromiseActorLogic<import('./types').AuthenticateSuccessEvent, import('./actors').AuthenticateInput, import('xstate').EventObject>;
+    id: string | undefined;
+} | {
+    src: "refreshAccessToken";
+    logic: import('xstate').PromiseActorLogic<import('./types').RefreshTokenSuccessEvent, import('./actors').RefreshTokenInput, import('xstate').EventObject>;
+    id: string | undefined;
+} | {
+    src: "unauthenticate";
+    logic: import('xstate').PromiseActorLogic<import('./types').UnauthenticateSuccessEvent, import('./actors').UnauthenticateInput, import('xstate').EventObject>;
+    id: string | undefined;
+}, {
+    type: "addError";
+    params: import('xstate').NonReducibleUnknown;
+} | {
+    type: "clearErrors";
+    params: import('xstate').NonReducibleUnknown;
+} | {
+    type: "notifyAuthenticated";
+    params: import('xstate').NonReducibleUnknown;
+} | {
+    type: "setAccessToken";
+    params: import('xstate').NonReducibleUnknown;
+} | {
+    type: "setIgnoreRefreshToken";
+    params: import('xstate').NonReducibleUnknown;
+} | {
+    type: "setUserContext";
+    params: import('xstate').NonReducibleUnknown;
+} | {
+    type: "unsetRefreshToken";
+    params: import('xstate').NonReducibleUnknown;
+} | {
+    type: "unsetUserContext";
+    params: import('xstate').NonReducibleUnknown;
+}, never, "refresh", "refreshing" | "authenticating" | "loggedIn" | "loggedOut" | "unauthenticating" | "loggedInReady", string, {
+    initialContext: Partial<import('./types').AuthMachineContext>;
+    initialState?: string;
+}, import('xstate').NonReducibleUnknown, import('./types').AuthenticatedEmittedEvent, import('xstate').MetaObject, {
+    id: "auth";
+    states: {
+        readonly authenticating: {};
+        readonly unauthenticating: {};
+        readonly refreshing: {};
+        readonly loggedOut: {};
+        readonly loggedInReady: {};
+        readonly loggedIn: {};
+    };
+}>>>;
+export declare const useAuth: () => AuthContextType;
+type AuthOptions = {
+    inspect: Observer<InspectionEvent> | undefined;
+    endpoints: {
+        login: string;
+        logout: string;
+        refresh: string;
+        ssrRefresh: string;
+    };
+};
+/**
+ * runs on server side as part of withAuth HOF
+ *
+ * @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('./types').AuthMachineContext, import('./types').RefreshTokenEvent | import('./types').LoginEvent | import('./types').LogoutEvent | import('./types').ClearErrorsEvent | import('./types').RestoreEvent | import('xstate').DoneActorEvent<import('./types').AuthenticateSuccessEvent, string> | import('xstate').DoneActorEvent<import('./types').RefreshTokenSuccessEvent, string>, {
+    [x: string]: import('xstate').ActorRefFromLogic<import('xstate').PromiseActorLogic<import('./types').AuthenticateSuccessEvent, import('./actors').AuthenticateInput, import('xstate').EventObject>> | import('xstate').ActorRefFromLogic<import('xstate').PromiseActorLogic<import('./types').RefreshTokenSuccessEvent, import('./actors').RefreshTokenInput, import('xstate').EventObject>> | import('xstate').ActorRefFromLogic<import('xstate').PromiseActorLogic<import('./types').UnauthenticateSuccessEvent, import('./actors').UnauthenticateInput, import('xstate').EventObject>> | undefined;
+}, {
+    src: "authenticate";
+    logic: import('xstate').PromiseActorLogic<import('./types').AuthenticateSuccessEvent, import('./actors').AuthenticateInput, import('xstate').EventObject>;
+    id: string | undefined;
+} | {
+    src: "refreshAccessToken";
+    logic: import('xstate').PromiseActorLogic<import('./types').RefreshTokenSuccessEvent, import('./actors').RefreshTokenInput, import('xstate').EventObject>;
+    id: string | undefined;
+} | {
+    src: "unauthenticate";
+    logic: import('xstate').PromiseActorLogic<import('./types').UnauthenticateSuccessEvent, import('./actors').UnauthenticateInput, import('xstate').EventObject>;
+    id: string | undefined;
+}, {
+    type: "addError";
+    params: import('xstate').NonReducibleUnknown;
+} | {
+    type: "clearErrors";
+    params: import('xstate').NonReducibleUnknown;
+} | {
+    type: "notifyAuthenticated";
+    params: import('xstate').NonReducibleUnknown;
+} | {
+    type: "setAccessToken";
+    params: import('xstate').NonReducibleUnknown;
+} | {
+    type: "setIgnoreRefreshToken";
+    params: import('xstate').NonReducibleUnknown;
+} | {
+    type: "setUserContext";
+    params: import('xstate').NonReducibleUnknown;
+} | {
+    type: "unsetRefreshToken";
+    params: import('xstate').NonReducibleUnknown;
+} | {
+    type: "unsetUserContext";
+    params: import('xstate').NonReducibleUnknown;
+}, never, "refresh", "refreshing" | "authenticating" | "loggedIn" | "loggedOut" | "unauthenticating" | "loggedInReady", string, {
+    initialContext: Partial<import('./types').AuthMachineContext>;
+    initialState?: string;
+}, import('xstate').NonReducibleUnknown, import('./types').AuthenticatedEmittedEvent, import('xstate').MetaObject, {
+    id: "auth";
+    states: {
+        readonly authenticating: {};
+        readonly unauthenticating: {};
+        readonly refreshing: {};
+        readonly loggedOut: {};
+        readonly loggedInReady: {};
+        readonly loggedIn: {};
+    };
+}>>>;
+type Props = {
+    children: ReactNode;
+    actor: Actor<typeof authMachine>;
+};
+export declare function AuthProvider({ actor, children }: Props): import("react/jsx-runtime").JSX.Element;
+export {};

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,8 @@
+export * from './addError';
+export * from './clearErrors';
+export * from './notifyAuthenticated';
+export * from './setAccessToken';
+export * from './setIgnoreRefreshToken';
+export * from './setUserContext';
+export * from './unsetRefreshToken';
+export * from './unsetUserContext';

package/auth/actions/notifyAuthenticated.d.ts

@@ -0,0 +1,6 @@
+import { AuthenticatedEmittedEvent, AuthMachineContext, AuthMachineEvents } from '../types';
+export declare function notifyAuthenticated({ event, }: {
+    context: AuthMachineContext;
+    event: AuthMachineEvents;
+}): AuthenticatedEmittedEvent;
+export default notifyAuthenticated;

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, import('xstate').EventObject>;
+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, import('xstate').EventObject>;
+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, import('xstate').EventObject>;
+export default unauthenticate;

package/auth/auth.d.ts

@@ -0,0 +1,54 @@
+import { AuthMachineContext } from './types';
+export declare const authMachine: import('xstate').StateMachine<AuthMachineContext, import('./types').RefreshTokenEvent | import('./types').LoginEvent | import('./types').LogoutEvent | import('./types').ClearErrorsEvent | import('./types').RestoreEvent | import('xstate').DoneActorEvent<import('./types').AuthenticateSuccessEvent, string> | import('xstate').DoneActorEvent<import('./types').RefreshTokenSuccessEvent, string>, {
+    [x: string]: import('xstate').ActorRefFromLogic<import('xstate').PromiseActorLogic<import('./types').AuthenticateSuccessEvent, import('./actors').AuthenticateInput, import('xstate').EventObject>> | import('xstate').ActorRefFromLogic<import('xstate').PromiseActorLogic<import('./types').RefreshTokenSuccessEvent, import('./actors').RefreshTokenInput, import('xstate').EventObject>> | import('xstate').ActorRefFromLogic<import('xstate').PromiseActorLogic<import('./types').UnauthenticateSuccessEvent, import('./actors').UnauthenticateInput, import('xstate').EventObject>> | undefined;
+}, {
+    src: "authenticate";
+    logic: import('xstate').PromiseActorLogic<import('./types').AuthenticateSuccessEvent, import('./actors').AuthenticateInput, import('xstate').EventObject>;
+    id: string | undefined;
+} | {
+    src: "refreshAccessToken";
+    logic: import('xstate').PromiseActorLogic<import('./types').RefreshTokenSuccessEvent, import('./actors').RefreshTokenInput, import('xstate').EventObject>;
+    id: string | undefined;
+} | {
+    src: "unauthenticate";
+    logic: import('xstate').PromiseActorLogic<import('./types').UnauthenticateSuccessEvent, import('./actors').UnauthenticateInput, import('xstate').EventObject>;
+    id: string | undefined;
+}, {
+    type: "addError";
+    params: import('xstate').NonReducibleUnknown;
+} | {
+    type: "clearErrors";
+    params: import('xstate').NonReducibleUnknown;
+} | {
+    type: "notifyAuthenticated";
+    params: import('xstate').NonReducibleUnknown;
+} | {
+    type: "setAccessToken";
+    params: import('xstate').NonReducibleUnknown;
+} | {
+    type: "setIgnoreRefreshToken";
+    params: import('xstate').NonReducibleUnknown;
+} | {
+    type: "setUserContext";
+    params: import('xstate').NonReducibleUnknown;
+} | {
+    type: "unsetRefreshToken";
+    params: import('xstate').NonReducibleUnknown;
+} | {
+    type: "unsetUserContext";
+    params: import('xstate').NonReducibleUnknown;
+}, never, "refresh", "refreshing" | "authenticating" | "loggedIn" | "loggedOut" | "unauthenticating" | "loggedInReady", string, {
+    initialContext: Partial<AuthMachineContext>;
+    initialState?: string;
+}, import('xstate').NonReducibleUnknown, import('./types').AuthenticatedEmittedEvent, import('xstate').MetaObject, {
+    id: "auth";
+    states: {
+        readonly authenticating: {};
+        readonly unauthenticating: {};
+        readonly refreshing: {};
+        readonly loggedOut: {};
+        readonly loggedInReady: {};
+        readonly loggedIn: {};
+    };
+}>;
+export default authMachine;

package/auth/types.d.ts

@@ -0,0 +1,50 @@
+import { DoneActorEvent } from 'xstate';
+export interface AuthMachineContext {
+    user: Record<string, any> | null;
+    accessToken: string;
+    refreshToken: string;
+    ignoreRefreshToken: boolean;
+    endpoints: {
+        login: string;
+        logout: string;
+        refresh: string;
+        ssrRefresh: string;
+    };
+    errors: Array<string>;
+}
+export interface RefreshTokenEvent {
+    type: 'REFRESH_TOKEN';
+    accessToken: AuthMachineContext['accessToken'];
+}
+export interface LoginEvent {
+    type: 'LOGIN';
+    username: string;
+    password: string;
+}
+export interface LogoutEvent {
+    type: 'LOGOUT';
+}
+export interface ClearErrorsEvent {
+    type: 'CLEAR_ERRORS';
+}
+export interface RestoreEvent {
+    type: 'RESTORE';
+}
+export interface AuthenticateSuccessEvent {
+    type: 'AUTHENTICATE_SUCCESS';
+    user: Partial<AuthMachineContext['user']>;
+    accessToken: AuthMachineContext['accessToken'];
+}
+export interface RefreshTokenSuccessEvent {
+    type: 'REFRESH_TOKEN_SUCCESS';
+    accessToken: AuthMachineContext['accessToken'];
+}
+export interface UnauthenticateSuccessEvent {
+    type: 'UNAUTHENTICATE_SUCCESS';
+}
+export interface AuthenticatedEmittedEvent {
+    type: 'EMIT_AUTHENTICATED';
+    accessToken: AuthMachineContext['accessToken'];
+}
+export type AuthMachineEvents = RefreshTokenEvent | RestoreEvent | LoginEvent | LogoutEvent | ClearErrorsEvent | DoneActorEvent<AuthenticateSuccessEvent> | DoneActorEvent<RefreshTokenSuccessEvent>;
+export type AuthMachineEmittedEvents = AuthenticatedEmittedEvent;

package/helpers/request.d.ts

@@ -0,0 +1,2 @@
+export declare function request<T>(url: string, options: object): Promise<T>;
+export default request;