@oneblink/apps-react 9.0.0-beta.1 → 9.0.0-beta.3

package/dist/apps/auth-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth-service.js","sourceRoot":"","sources":["../../src/apps/auth-service.ts"],"names":[],"mappings":"AACA,OAAO,iBAAiB,MAAM,qCAAqC,CAAA;AACnE,OAAO,EACL,UAAU,EACV,aAAa,EACb,gBAAgB,GACjB,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EACL,IAAI,IAAI,WAAW,EACnB,oBAAoB,EACpB,UAAU,EACV,aAAa,EACb,qBAAqB,EACrB,cAAc,EACd,cAAc,EACd,oBAAoB,EACpB,cAAc,EACd,MAAM,IAAI,aAAa,EACvB,cAAc,EACd,WAAW,EACX,mBAAmB,EAEnB,iBAAiB,EACjB,UAAU,EACV,QAAQ,EACR,oBAAoB,GACrB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,UAAU,EAAE,WAAW,EAAa,MAAM,kBAAkB,CAAA;AACrE,OAAO,OAAO,MAAM,WAAW,CAAA;AAC/B,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAClE,OAAO,YAAY,MAAM,kBAAkB,CAAA;AAE3C,OAAO,EACL,oBAAoB,EACpB,aAAa,EACb,qBAAqB,EACrB,oBAAoB,EACpB,cAAc,EACd,cAAc,EACd,cAAc,EACd,UAAU,EACV,UAAU,EACV,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,YAAY,EACZ,YAAY,EACZ,mBAAmB,EAEnB,iBAAiB,EACjB,UAAU,EACV,QAAQ,EACR,oBAAoB,GACrB,CAAA;AACD,OAAO,MAAM,MAAM,UAAU,CAAA;AAE7B;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM;IAC1B,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAA;IAE7B,IAAI,CAAC;QACH,MAAM,YAAY,CAAC,WAAW,CAAC,KAAK,EAAE,CAAA;IACxC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;QAC9B,OAAO,CAAC,IAAI,CAAC,gDAAgD,EAAE,KAAK,CAAC,CAAA;IACvE,CAAC;IAED,MAAM,aAAa,EAAE,CAAA;AACvB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,IAAI,CAAC,EAAE,aAAa,EAA6B;IAC/D,WAAW,CAAC;QACV,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,SAAS;QACjC,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,WAAW;QACxC,aAAa;QACb,WAAW,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,WAAW;QACjD,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,SAAS;KAC9C,CAAC,CAAA;IAEF,MAAM,QAAQ,GAAG,GAAG,EAAE;QACpB,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,WAAW,EAAE,IAAI,SAAS,CAAC,CAAA;IACvD,CAAC,CAAA;IACD,QAAQ,EAAE,CAAA;IACV,oBAAoB,CAAC,QAAQ,CAAC,CAAA;AAChC,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,UAAkB,EAClB,WAAyB;IAEzB,OAAO,sBAAsB,CAAC,UAAU,EAAE,WAAW,CAAC;SACnD,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC;SAChB,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACf,IAAI,KAAK,CAAC,MAAM,IAAI,GAAG,IAAI,KAAK,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;YAC9C,OAAO,KAAK,CAAA;QACd,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;YAC9B,OAAO,CAAC,GAAG,CACT,sEAAsE,EACtE,KAAK,CACN,CAAA;YACD,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC,CAAC,CAAA;AACN,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,UAAkB,EAClB,WAAyB;IASzB,IAAI,aAAa,EAAE,EAAE,CAAC;QACpB,OAAO;YACL,UAAU;YACV,MAAM,EAAE,EAAE;SACX,CAAA;IACH,CAAC;IAED,MAAM,WAAW,GAAG,cAAc,EAAE,CAAA;IAEpC,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,eAAe,UAAU,oBAAoB,CAAA;IACrF,OAAO,MAAM,UAAU,CAIpB,GAAG,EAAE,WAAW,CAAC,CAAA;AACtB,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,UAAkB;IACpD,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;QAClB,MAAM,IAAI,iBAAiB,CACzB,6DAA6D,EAC7D;YACE,aAAa,EAAE,IAAI;SACpB,CACF,CAAA;IACH,CAAC;IAED,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,eAAe,UAAU,iBAAiB,CAAA;QAClF,MAAM,WAAW,CAAC,GAAG,CAAC,CAAA;IACxB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;QAC9B,OAAO,CAAC,IAAI,CAAC,4CAA4C,EAAE,KAAK,CAAC,CAAA;QAEjE,MAAM,IAAI,iBAAiB,CACzB,oJAAoJ,EACpJ;YACE,aAAa,EAAE,KAAc;YAC7B,KAAK,EAAE,yBAAyB;YAChC,cAAc,EAAG,KAAmB,CAAC,MAAM;SAC5C,CACF,CAAA;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AAEH,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,EAC3B,UAAU,EACV,KAAK,EACL,SAAS,EACT,QAAQ,GAMT;IACC,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,eAAe,UAAU,UAAU,CAAA;QAC3E,OAAO,MAAM,WAAW,CAAC,GAAG,EAAE;YAC5B,KAAK;YACL,SAAS;YACT,QAAQ;SACT,CAAC,CAAA;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;QAC9B,OAAO,CAAC,IAAI,CAAC,0CAA0C,EAAE,KAAK,CAAC,CAAA;QAE/D,MAAM,IAAI,iBAAiB,CACzB,4IAA4I,EAC5I;YACE,aAAa,EAAE,KAAc;YAC7B,KAAK,EAAE,kBAAkB;YACzB,cAAc,EAAG,KAAmB,CAAC,MAAM;SAC5C,CACF,CAAA;IACH,CAAC;AACH,CAAC","sourcesContent":["import { MiscTypes } from '@oneblink/types'\nimport OneBlinkAppsError from './services/errors/oneBlinkAppsError'\nimport {\n  getIdToken,\n  getFormsKeyId,\n  setFormsKeyToken,\n} from './services/forms-key'\nimport {\n  init as initCognito,\n  registerAuthListener,\n  isLoggedIn,\n  loginHostedUI,\n  loginUsernamePassword,\n  changePassword,\n  forgotPassword,\n  handleAuthentication,\n  logoutHostedUI,\n  logout as logoutCognito,\n  getUserProfile,\n  getUsername,\n  getUserFriendlyName,\n  LoginAttemptResponse,\n  checkIsMfaEnabled,\n  disableMfa,\n  setupMfa,\n  generateMfaQrCodeUrl,\n} from './services/cognito'\nimport { getRequest, postRequest, HTTPError } from './services/fetch'\nimport tenants from './tenants'\nimport { getUserToken, setUserToken } from './services/user-token'\nimport utilsService from './services/utils'\n\nexport {\n  registerAuthListener,\n  loginHostedUI,\n  loginUsernamePassword,\n  handleAuthentication,\n  logoutHostedUI,\n  changePassword,\n  forgotPassword,\n  isLoggedIn,\n  getIdToken,\n  getUserProfile,\n  getFormsKeyId,\n  setFormsKeyToken,\n  getUserToken,\n  setUserToken,\n  getUserFriendlyName,\n  LoginAttemptResponse,\n  checkIsMfaEnabled,\n  disableMfa,\n  setupMfa,\n  generateMfaQrCodeUrl,\n}\nimport Sentry from './Sentry'\n\n/**\n * Log the current user out and remove an data stored locally by the user e.g.\n * drafts.\n *\n * #### Example\n *\n * ```js\n * await authService.logout()\n * ```\n */\nexport async function logout() {\n  console.log('Logging out...')\n\n  try {\n    await utilsService.localForage.clear()\n  } catch (error) {\n    Sentry.captureException(error)\n    console.warn('Could not clear localForage before logging out', error)\n  }\n\n  await logoutCognito()\n}\n\n/**\n * Initialize the service with required configuration. **This must be done\n * before using before some of the function in this service.**\n *\n * #### Example\n *\n * ```js\n * authService.init({\n *   oAuthClientId: 'YOUR_OAUTH_CLIENT_ID',\n * })\n * ```\n *\n * @param options\n */\nexport function init({ oAuthClientId }: { oAuthClientId: string }) {\n  initCognito({\n    region: tenants.current.awsRegion,\n    loginDomain: tenants.current.loginDomain,\n    oAuthClientId,\n    redirectUri: window.location.origin + '/callback',\n    logoutUri: window.location.origin + '/logout',\n  })\n\n  const listener = () => {\n    Sentry.setTag('username', getUsername() || undefined)\n  }\n  listener()\n  registerAuthListener(listener)\n}\n\n/**\n * Determine if the current user is a OneBlink App User for a OneBlink Forms\n * App. Returns `false` if the current user is not logged in.\n *\n * #### Example\n *\n * ```js\n * const formsAppId = 1\n * const isAuthorised = await authService.isAuthorised(formsAppId)\n * if (!isAuthorised) {\n *   // handle unauthorised user\n * }\n * ```\n *\n * @param formsAppId\n * @param abortSignal\n * @returns\n */\nexport async function isAuthorised(\n  formsAppId: number,\n  abortSignal?: AbortSignal,\n): Promise<boolean> {\n  return getCurrentFormsAppUser(formsAppId, abortSignal)\n    .then(() => true)\n    .catch((error) => {\n      if (error.status >= 400 && error.status < 500) {\n        return false\n      } else {\n        Sentry.captureException(error)\n        console.log(\n          'Could not determine if the current user has access to this forms app',\n          error,\n        )\n        return false\n      }\n    })\n}\n\n/**\n * Get the current user's App User details for a OneBlink Forms App. Returns\n * `undefined` if the current user is not logged in.\n *\n * #### Example\n *\n * ```js\n * const formsAppId = 1\n * const formsAppUserDetails =\n *   await authService.getCurrentFormsAppUser(formsAppId)\n * if (!formsAppUserDetails) {\n *   // handle unauthorised user\n * }\n * ```\n *\n * @param formsAppId\n * @returns\n */\nexport async function getCurrentFormsAppUser(\n  formsAppId: number,\n  abortSignal?: AbortSignal,\n): Promise<\n  | {\n      userProfile?: MiscTypes.UserProfile\n      formsAppId: number\n      groups: string[]\n    }\n  | undefined\n> {\n  if (getFormsKeyId()) {\n    return {\n      formsAppId,\n      groups: [],\n    }\n  }\n\n  const userProfile = getUserProfile()\n\n  if (!userProfile) {\n    return undefined\n  }\n\n  const url = `${tenants.current.apiOrigin}/forms-apps/${formsAppId}/my-forms-app-user`\n  return await getRequest<{\n    userProfile?: MiscTypes.UserProfile\n    formsAppId: number\n    groups: string[]\n  }>(url, abortSignal)\n}\n\n/**\n * If the current user is not a Forms App User, this function will send a\n * request on behalf of the current user to the OneBlink Forms App\n * administrators to request access.\n *\n * #### Example\n *\n * ```js\n * const formsAppId = 1\n * await authService.requestAccess(formsAppId)\n * // Display a message to user indicating a request has been sent to the application administrators\n * ```\n *\n * @param formsAppId\n */\nexport async function requestAccess(formsAppId: number): Promise<void> {\n  if (!isLoggedIn()) {\n    throw new OneBlinkAppsError(\n      'You must login before requesting access to this application',\n      {\n        requiresLogin: true,\n      },\n    )\n  }\n\n  try {\n    const url = `${tenants.current.apiOrigin}/forms-apps/${formsAppId}/request-access`\n    await postRequest(url)\n  } catch (error) {\n    Sentry.captureException(error)\n    console.warn('Error while requesting access to forms app', error)\n\n    throw new OneBlinkAppsError(\n      'Sorry, we could not request access automatically right now, please try again. If the problem persists, please contact your administrator yourself.',\n      {\n        originalError: error as Error,\n        title: 'Error Requesting Access',\n        httpStatusCode: (error as HTTPError).status,\n      },\n    )\n  }\n}\n\n/**\n * Allow a user to sign up to a forms app.\n *\n * #### Example\n *\n * ```js\n * await authService.signUp({\n *   formsAppId: 1,\n *   email: 'test@oneblink.io',\n *   firstName: 'first',\n *   lastName: 'last',\n * })\n * ```\n *\n * @param {formsAppId, email, generatePassword, firstName, lastName}\n * @returns\n */\n\nexport async function signUp({\n  formsAppId,\n  email,\n  firstName,\n  lastName,\n}: {\n  formsAppId: number\n  email: string\n  firstName?: string\n  lastName?: string\n}): Promise<void> {\n  try {\n    const url = `${tenants.current.apiOrigin}/forms-apps/${formsAppId}/sign-up`\n    return await postRequest(url, {\n      email,\n      firstName,\n      lastName,\n    })\n  } catch (error) {\n    Sentry.captureException(error)\n    console.warn('Error while calling sign-up to forms app', error)\n\n    throw new OneBlinkAppsError(\n      'Sorry, we could not create you a account right now, please try again. If the problem persists, please contact your administrator yourself.',\n      {\n        originalError: error as Error,\n        title: 'Error Signing up',\n        httpStatusCode: (error as HTTPError).status,\n      },\n    )\n  }\n}\n"]}

package/dist/apps/auto-save-service.d.ts

@@ -0,0 +1,82 @@
+/**
+ * Get keys for autosave data.
+ *
+ * #### Example
+ *
+ * ```js
+ * const keys = await autoSaveService.getAutoSaveDataKeys()
+ * if (keys.length) {
+ *   // Display keys to user
+ * }
+ * ```
+ *
+ * @returns
+ */
+export declare function getAutoSaveKeys(): Promise<string[]>;
+/**
+ * Get saved data.
+ *
+ * #### Example
+ *
+ * ```js
+ * const formId = 1
+ * const myKey = 'my-key'
+ * const prefillData = await autoSaveService.getAutoSaveData(formId, myKey)
+ * if (prefillData) {
+ *   // Ask user if they would like to continue with this prefill data.
+ * }
+ * ```
+ *
+ * @param formId
+ * @param autoSaveKey
+ * @returns
+ */
+export declare function getAutoSaveData<T>(formId: number, autoSaveKey: string | null | undefined): Promise<T | null>;
+/**
+ * Create or update saved data.
+ *
+ * #### Example
+ *
+ * ```js
+ * const formId = 1
+ * const myKey = 'my-key'
+ * await autoSaveService.upsertAutoSaveData(formId, myKey, {
+ *   form: 'data',
+ *   goes: 'here',
+ * })
+ * ```
+ *
+ * @param formId
+ * @param autoSaveKey
+ * @param model
+ * @returns
+ */
+export declare function upsertAutoSaveData<T extends Record<string, unknown>>(formId: number, autoSaveKey: string | null | undefined, model: T): Promise<T>;
+/**
+ * Delete saved data.
+ *
+ * #### Example
+ *
+ * ```js
+ * const formId = 1
+ * const myKey = 'my-key'
+ * await autoSaveService.deleteAutoSaveData(formId, myKey)
+ * ```
+ *
+ * @param formId
+ * @param autoSaveKey
+ * @returns
+ */
+export declare function deleteAutoSaveData(formId: number, autoSaveKey: string | null | undefined): Promise<void>;
+/**
+ * Delete all auto saved data.
+ *
+ * #### Example
+ *
+ * ```js
+ * await autoSaveService.deleteAllAutosaveData()
+ * ```
+ *
+ * @returns
+ */
+export declare function deleteAllAutosaveData(): Promise<void>;

package/dist/apps/auto-save-service.js

@@ -0,0 +1,105 @@
+import utilsService from './services/utils';
+const defaultAutoSaveKey = 'NO_AUTO_SAVE_KEY';
+const autosaveKeyPrefix = 'AUTO_SAVE_';
+function getAutoSaveKey(formId, autoSaveKey) {
+    return `${autosaveKeyPrefix}${formId}_${autoSaveKey || defaultAutoSaveKey}`;
+}
+/**
+ * Get keys for autosave data.
+ *
+ * #### Example
+ *
+ * ```js
+ * const keys = await autoSaveService.getAutoSaveDataKeys()
+ * if (keys.length) {
+ *   // Display keys to user
+ * }
+ * ```
+ *
+ * @returns
+ */
+export async function getAutoSaveKeys() {
+    return await utilsService.getLocalForageKeys(autosaveKeyPrefix);
+}
+/**
+ * Get saved data.
+ *
+ * #### Example
+ *
+ * ```js
+ * const formId = 1
+ * const myKey = 'my-key'
+ * const prefillData = await autoSaveService.getAutoSaveData(formId, myKey)
+ * if (prefillData) {
+ *   // Ask user if they would like to continue with this prefill data.
+ * }
+ * ```
+ *
+ * @param formId
+ * @param autoSaveKey
+ * @returns
+ */
+export async function getAutoSaveData(formId, autoSaveKey) {
+    const key = getAutoSaveKey(formId, autoSaveKey);
+    return utilsService.getLocalForageItem(key);
+}
+/**
+ * Create or update saved data.
+ *
+ * #### Example
+ *
+ * ```js
+ * const formId = 1
+ * const myKey = 'my-key'
+ * await autoSaveService.upsertAutoSaveData(formId, myKey, {
+ *   form: 'data',
+ *   goes: 'here',
+ * })
+ * ```
+ *
+ * @param formId
+ * @param autoSaveKey
+ * @param model
+ * @returns
+ */
+export async function upsertAutoSaveData(formId, autoSaveKey, model) {
+    const key = getAutoSaveKey(formId, autoSaveKey);
+    return utilsService.setLocalForageItem(key, model);
+}
+/**
+ * Delete saved data.
+ *
+ * #### Example
+ *
+ * ```js
+ * const formId = 1
+ * const myKey = 'my-key'
+ * await autoSaveService.deleteAutoSaveData(formId, myKey)
+ * ```
+ *
+ * @param formId
+ * @param autoSaveKey
+ * @returns
+ */
+export async function deleteAutoSaveData(formId, autoSaveKey) {
+    const key = getAutoSaveKey(formId, autoSaveKey);
+    return utilsService.removeLocalForageItem(key);
+}
+/**
+ * Delete all auto saved data.
+ *
+ * #### Example
+ *
+ * ```js
+ * await autoSaveService.deleteAllAutosaveData()
+ * ```
+ *
+ * @returns
+ */
+export async function deleteAllAutosaveData() {
+    const keys = await getAutoSaveKeys();
+    console.log('Deleting all autosave data from local forage...');
+    await Promise.all(keys.map((k) => utilsService.removeLocalForageItem(k)));
+    console.log('All Autosave data deleted from local forage successfully.');
+}
+//# sourceMappingURL=auto-save-service.js.map

package/dist/apps/auto-save-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auto-save-service.js","sourceRoot":"","sources":["../../src/apps/auto-save-service.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,kBAAkB,CAAA;AAE3C,MAAM,kBAAkB,GAAG,kBAAkB,CAAA;AAC7C,MAAM,iBAAiB,GAAG,YAAY,CAAA;AAEtC,SAAS,cAAc,CACrB,MAAc,EACd,WAAsC;IAEtC,OAAO,GAAG,iBAAiB,GAAG,MAAM,IAAI,WAAW,IAAI,kBAAkB,EAAE,CAAA;AAC7E,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe;IACnC,OAAO,MAAM,YAAY,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAA;AACjE,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,MAAc,EACd,WAAsC;IAEtC,MAAM,GAAG,GAAG,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IAC/C,OAAO,YAAY,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAA;AAC7C,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,MAAc,EACd,WAAsC,EACtC,KAAQ;IAER,MAAM,GAAG,GAAG,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IAC/C,OAAO,YAAY,CAAC,kBAAkB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;AACpD,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,MAAc,EACd,WAAsC;IAEtC,MAAM,GAAG,GAAG,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IAC/C,OAAO,YAAY,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAA;AAChD,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB;IACzC,MAAM,IAAI,GAAG,MAAM,eAAe,EAAE,CAAA;IACpC,OAAO,CAAC,GAAG,CAAC,iDAAiD,CAAC,CAAA;IAC9D,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACzE,OAAO,CAAC,GAAG,CAAC,2DAA2D,CAAC,CAAA;AAC1E,CAAC","sourcesContent":["import utilsService from './services/utils'\n\nconst defaultAutoSaveKey = 'NO_AUTO_SAVE_KEY'\nconst autosaveKeyPrefix = 'AUTO_SAVE_'\n\nfunction getAutoSaveKey(\n  formId: number,\n  autoSaveKey: string | null | undefined,\n) {\n  return `${autosaveKeyPrefix}${formId}_${autoSaveKey || defaultAutoSaveKey}`\n}\n\n/**\n * Get keys for autosave data.\n *\n * #### Example\n *\n * ```js\n * const keys = await autoSaveService.getAutoSaveDataKeys()\n * if (keys.length) {\n *   // Display keys to user\n * }\n * ```\n *\n * @returns\n */\nexport async function getAutoSaveKeys(): Promise<string[]> {\n  return await utilsService.getLocalForageKeys(autosaveKeyPrefix)\n}\n\n/**\n * Get saved data.\n *\n * #### Example\n *\n * ```js\n * const formId = 1\n * const myKey = 'my-key'\n * const prefillData = await autoSaveService.getAutoSaveData(formId, myKey)\n * if (prefillData) {\n *   // Ask user if they would like to continue with this prefill data.\n * }\n * ```\n *\n * @param formId\n * @param autoSaveKey\n * @returns\n */\nexport async function getAutoSaveData<T>(\n  formId: number,\n  autoSaveKey: string | null | undefined,\n): Promise<T | null> {\n  const key = getAutoSaveKey(formId, autoSaveKey)\n  return utilsService.getLocalForageItem(key)\n}\n\n/**\n * Create or update saved data.\n *\n * #### Example\n *\n * ```js\n * const formId = 1\n * const myKey = 'my-key'\n * await autoSaveService.upsertAutoSaveData(formId, myKey, {\n *   form: 'data',\n *   goes: 'here',\n * })\n * ```\n *\n * @param formId\n * @param autoSaveKey\n * @param model\n * @returns\n */\nexport async function upsertAutoSaveData<T extends Record<string, unknown>>(\n  formId: number,\n  autoSaveKey: string | null | undefined,\n  model: T,\n): Promise<T> {\n  const key = getAutoSaveKey(formId, autoSaveKey)\n  return utilsService.setLocalForageItem(key, model)\n}\n\n/**\n * Delete saved data.\n *\n * #### Example\n *\n * ```js\n * const formId = 1\n * const myKey = 'my-key'\n * await autoSaveService.deleteAutoSaveData(formId, myKey)\n * ```\n *\n * @param formId\n * @param autoSaveKey\n * @returns\n */\nexport async function deleteAutoSaveData(\n  formId: number,\n  autoSaveKey: string | null | undefined,\n): Promise<void> {\n  const key = getAutoSaveKey(formId, autoSaveKey)\n  return utilsService.removeLocalForageItem(key)\n}\n\n/**\n * Delete all auto saved data.\n *\n * #### Example\n *\n * ```js\n * await autoSaveService.deleteAllAutosaveData()\n * ```\n *\n * @returns\n */\nexport async function deleteAllAutosaveData() {\n  const keys = await getAutoSaveKeys()\n  console.log('Deleting all autosave data from local forage...')\n  await Promise.all(keys.map((k) => utilsService.removeLocalForageItem(k)))\n  console.log('All Autosave data deleted from local forage successfully.')\n}\n"]}

package/dist/apps/draft-service.d.ts

@@ -0,0 +1,148 @@
+import { getLatestFormSubmissionDraftVersion } from './services/draft-data-store';
+import { DraftSubmission, DraftSubmissionInput, LocalFormSubmissionDraft, ProgressListener } from './types/submissions';
+/**
+ * Register a listener function that will be passed an array of Drafts when a
+ * draft is added, updated or deleted.
+ *
+ * #### Example
+ *
+ * ```js
+ * const listener = async (drafts) => {
+ *   // use drafts here...
+ * }
+ * const deregister = await draftService.registerDraftsListener(listener)
+ *
+ * // When no longer needed, remember to deregister the listener
+ * deregister()
+ * ```
+ *
+ * @param listener
+ * @returns
+ */
+declare function registerDraftsListener(listener: (drafts: LocalFormSubmissionDraft[]) => unknown): () => void;
+/**
+ * Create or update a Draft in the local store and sync it with remote drafts.
+ * Will also handle cleaning up auto save data (if the `autoSaveKey` property is
+ * passed).
+ *
+ * #### Example
+ *
+ * ```js
+ * const abortController = new AbortController()
+ * const formSubmissionDraftId = 'd3aeb944-d0b3-11ea-87d0-0242ac130003' // pass `undefined` to create a new draft
+ * const autoSaveKey = 'SET ME TO DELETE AUTOSAVE DATA AFTER SAVING DRAFT'
+ * const draftSubmissionInput = {
+ *   title: 1,
+ *   formsAppId: 1,
+ *   submission: {
+ *     form: 'data',
+ *     goes: 'here',
+ *   },
+ *   definition: {
+ *     form: 'definition',
+ *     goes: 'here',
+ *   },
+ * }
+ * await draftService.upsertDraft({
+ *   formSubmissionDraftId,
+ *   autoSaveKey,
+ *   draftSubmissionInput,
+ *   abortSignal: abortController.signal,
+ *   onProgress: (progress) => {
+ *     // ...
+ *   },
+ * })
+ * ```
+ *
+ * @param options
+ * @returns
+ */
+declare function upsertDraft({ formSubmissionDraftId, draftSubmissionInput, autoSaveKey, onProgress, abortSignal, pendingTimestamp, }: {
+    formSubmissionDraftId: string | undefined;
+    draftSubmissionInput: DraftSubmissionInput;
+    autoSaveKey?: string;
+    onProgress?: ProgressListener;
+    abortSignal?: AbortSignal;
+    pendingTimestamp?: string;
+}): Promise<void>;
+/**
+ * Get an array of Drafts for the currently logged in user.
+ *
+ * #### Example
+ *
+ * ```js
+ * const drafts = await draftService.getDrafts()
+ * ```
+ *
+ * @returns
+ */
+declare function getDrafts(): Promise<LocalFormSubmissionDraft[]>;
+/**
+ * Get an array of Drafts that have been submitted publicly on this device.
+ *
+ * #### Example
+ *
+ * ```js
+ * const drafts = await draftService.getPublicDrafts()
+ * ```
+ *
+ * @returns
+ */
+declare function getPublicDrafts(): Promise<LocalFormSubmissionDraft[]>;
+/**
+ * Get a single Draft and the associated submission data.
+ *
+ * #### Example
+ *
+ * ```js
+ * const draftId = 'd3aeb944-d0b3-11ea-87d0-0242ac130003'
+ * const { draft, draftData, lastElementUpdated } =
+ *   await draftService.getDraftAndData(draftId)
+ * // use "draftData" to prefill a from
+ * ```
+ *
+ * @param draftId
+ * @returns
+ */
+declare function getDraftAndData(formsAppId: number, formSubmissionDraftId: string | undefined | null, abortSignal: AbortSignal | undefined): Promise<DraftSubmission | undefined>;
+/**
+ * Remove a draft from the local store and sync with remote drafts.
+ *
+ * #### Example
+ *
+ * ```js
+ * const draftId = 'd3aeb944-d0b3-11ea-87d0-0242ac130003'
+ * await draftService.deleteDraft(draftId)
+ * ```
+ *
+ * @param draftId
+ * @param formsAppId
+ * @returns
+ */
+declare function deleteDraft(formSubmissionDraftId: string, formsAppId: number, abortSignal?: AbortSignal): Promise<void>;
+/**
+ * Force a sync of remote drafts with locally stored drafts. This function will
+ * swallow all errors thrown unless `true` is passed for the `throwError`
+ * property.
+ *
+ * #### Example
+ *
+ * ```js
+ * await draftService.syncDrafts({
+ *   throwError: true,
+ *   formsAppId: 1,
+ * })
+ * ```
+ *
+ * @param param0
+ * @returns
+ */
+declare function syncDrafts({ formsAppId, throwError, abortSignal, }: {
+    /** The id of the OneBlink Forms App to sync drafts with */
+    formsAppId: number;
+    /** `true` to throw errors while syncing */
+    throwError?: boolean;
+    /** Signal to abort the requests */
+    abortSignal?: AbortSignal;
+}): Promise<void>;
+export { registerDraftsListener, upsertDraft, getDraftAndData, getDrafts, getPublicDrafts, deleteDraft, syncDrafts, getLatestFormSubmissionDraftVersion, LocalFormSubmissionDraft, };