chore: renaming of extension and updated documentation

Co-authored-by: dackers86 <[email protected]>

Author: cabljac

.github/workflows/validate.yaml

@@ -19,3 +19,5 @@ jobs:
         run: npm run check:formatting
       - name: Check TS Compiles
         run: npm run check:typescript
+      - name: Check Spelling & Grammar
+        run: npm run check:spelling

dictionary.js

@@ -59,7 +59,11 @@ module.exports = [
   /^firebase/,
   /^href/,
   /^stringified/,
-  /^acknowledgement/,
-  /^acknowledgements/,
+  /^acknowledgment/,
+  /^acknowledgments/,
   /^unacknowledge/,
+  /^uid/,
+  /^nodemailer/,
+  /^archiver/,
+  /^unacknowledgment/,
 ];

docs.json

@@ -16,10 +16,10 @@
       ]
     ],
     [
-      "Record User Acknowledgements",
+      "Firestore Record Acknowledgments",
       [
-        ["Overview", "/record-user-acknowledgements"],
-        ["Reference API", "/record-user-acknowledgements/reference"]
+        ["Overview", "/firestore-record-acknowledgments"],
+        ["Reference API", "/firestore-record-acknowledgments/reference"]
       ]
     ],
     [

docs/export-user-data/usage.mdx

@@ -156,7 +156,7 @@ listResults.forEach((result) => {
 });
 ```
 
-To generate download links for the client, use the `getDownloadURL` function using a export files path:
+To generate download links for the client, use the `getDownloadURL` function using an export files path:
 
 ```js
 import { listAll, ref, getDownloadURL } from 'firebase/storage';

docs/record-user-acknowledgements/assets/admin-dashboard-example.png renamed to docs/firestore-record-acknowledgments/assets/admin-dashboard-example.png

@@ -1,10 +1,10 @@
-# Record User Acknowledgements
+# Firestore Record Acknowledgments
 
-The extension stores notices and acknowledgements as documents in a collection inside Firestore. You configure the collection during the installation process, when you set up the extension instance's configuration parameters.
+The extension stores notices and acknowledgments as documents in a collection inside Firestore. You configure the collection during the installation process, when you set up the extension instance's configuration parameters.
 
-The extensions' source code contains a [web app providing admin utilities](https://github.com/invertase/firebase-extensions/tree/main/extensions/firestore-record-user-acknowledgements/admin-dashboard) that you can run locally. This contains a notice builder UI that you can use to easily create and customize notices. Setup instructions are available in the above link provided. Once set up, navigate to [localhost:3000](http://localhost:3000) to see the notice builder tool.
+The extensions' source code contains a [web app providing admin utilities](https://github.com/invertase/firebase-extensions/tree/main/extensions/firestore-firestore-record-acknowledgments/admin-dashboard) that you can run locally. This contains a notice builder UI that you can use to easily create and customize notices. Setup instructions are available in the above link provided. Once set up, navigate to [localhost:3000](http://localhost:3000) to see the notice builder tool.
 
-![Admin Dashboard](/record-user-acknowldegements/assets/admin-dashboard-example.png)
+![Admin Dashboard](/firestore-record-acknowldegements/assets/admin-dashboard-example.png)
 
 ## Retrieving a notice
 
@@ -16,13 +16,13 @@ import { getFunctions, httpsCallable } from 'firebase/functions';
 const functions = getFunctions();
 const notice = await httpsCallable(
   functions,
-  'ext-firestore-record-user-acknowledgements-getNotice',
+  'ext-firestore-firestore-record-acknowledgments-getNotice',
 )({
   type: 'banner',
 });
 ```
 
-Note: if multiple instances of this extension are installed the callable function name might contain a unique identifier, e.g. `ext-firestore-record-user-acknowledgements-<id>-getNotice`.
+Note: if multiple instances of this extension are installed the callable function name might contain a unique identifier, e.g. `ext-firestore-firestore-record-acknowledgments-<id>-getNotice`.
 
 The response of the function call will contain the notice document data, along with whether the current authenticated user has acknowledged the notice.
 
@@ -34,43 +34,43 @@ import { getFunctions, httpsCallable } from 'firebase/functions';
 const functions = getFunctions();
 const notice = await httpsCallable(
   functions,
-  'ext-firestore-record-user-acknowledgements-getNotice',
+  'ext-firestore-firestore-record-acknowledgments-getNotice',
 )({
   type: 'banner',
   version: 2,
 });
 ```
 
-View the [reference API](/record-user-acknowldegements/reference) for full details on the response interface.
+View the [reference API](/firestore-record-acknowldegements/reference) for full details on the response interface.
 
 ## Acknowledging a notice
 
-To acknowledge a notice, the extension provides two callable functions which accept the notice ID: `acknowledgeNotice` & `unacknowledgeNotice`. The extension will keep historical records of each acknowledgement the callable functions are called multiple times for the same user and notice.
+To acknowledge a notice, the extension provides two callable functions which accept the notice ID: `acknowledgeNotice` & `unacknowledgeNotice`. The extension will keep historical records of each acknowledgment the callable functions are called multiple times for the same user and notice.
 
 For example, to acknowledge a notice:
 
 ```js
 import { getFunctions, httpsCallable } from "firebase/functions";
 
 const functions = getFunctions();
-await httpsCallable(functions, 'ext-firestore-record-user-acknowledgements-acknowledgeNotice)({
+await httpsCallable(functions, 'ext-firestore-firestore-record-acknowledgments-acknowledgeNotice)({
   noticeId: 'EA9QhZKKta9KXcckiasc',
 });
 ```
 
-In-case you need to capture custom preferences relating to an acknowledgement, you can provide custom metadata to the function, for example:
+In-case you need to capture custom preferences relating to an acknowledgment, you can provide custom metadata to the function, for example:
 
 ```js
-await httpsCallable(functions, 'ext-firestore-record-user-acknowledgements-acknowledgeNotice)({
+await httpsCallable(functions, 'ext-firestore-firestore-record-acknowledgments-acknowledgeNotice)({
   noticeId: 'EA9QhZKKta9KXcckiasc',
   metadata: { preference1: true, preference2: false },
 });
 ```
 
-You can also provide a custom “type” of acknowledgement (the default type is “seen”), for example:
+You can also provide a custom “type” of acknowledgment (the default type is “seen”), for example:
 
 ```js
-await httpsCallable(functions, 'ext-firestore-record-user-acknowledgements-acknowledgeNotice)({
+await httpsCallable(functions, 'ext-firestore-firestore-record-acknowledgments-acknowledgeNotice)({
   noticeId: 'EA9QhZKKta9KXcckiasc',
   type: 'seen',
 });
@@ -79,40 +79,40 @@ await httpsCallable(functions, 'ext-firestore-record-user-acknowledgements-ackno
 If you wish to unacknowledge a notice, call the `unacknowledgeNotice` function:
 
 ```js
-await httpsCallable(functions, 'ext-firestore-record-user-acknowledgements-unacknowledgeNotice)({
+await httpsCallable(functions, 'ext-firestore-firestore-record-acknowledgments-unacknowledgeNotice)({
   noticeId: 'EA9QhZKKta9KXcckiasc',
   metadata: { reason: '...' },
 });
 ```
 
-## Retrieving acknowledgements
+## Retrieving acknowledgments
 
-To retrieve all previous user notice acknowledgements, call the `getAcknowledgements` callable function. This function will return an ordered array of all acknowledgements along with the notice data:
+To retrieve all previous user notice acknowledgments, call the `getAcknowledgments` callable function. This function will return an ordered array of all acknowledgments along with the notice data:
 
 ```js
 import { getFunctions, httpsCallable } from "firebase/functions";
 
 const functions = getFunctions();
-const acknowledgements  = await httpsCallable(functions, 'ext-firestore-record-user-acknowledgements-getAcknowledgements)();
+const acknowledgments  = await httpsCallable(functions, 'ext-firestore-firestore-record-acknowledgments-getAcknowledgments)();
 ```
 
-By default this won’t include unacknowledgement documents, however if those are required you can provide a `includeUnacknowledgements` property to the call:
+By default this won’t include unacknowledgment documents, however if those are required you can provide a `includeUnacknowledgments` property to the call:
 
 ```js
 import { getFunctions, httpsCallable } from "firebase/functions";
 
 const functions = getFunctions();
-const acknowledgements  = await httpsCallable(functions, 'ext-firestore-record-user-acknowledgements-getAcknowledgements)({
-  includeUnacknowledgements: true,
+const acknowledgments  = await httpsCallable(functions, 'ext-firestore-firestore-record-acknowledgments-getAcknowledgments)({
+  includeUnacknowledgments: true,
 });
 ```
 
-## User specific acknowledgements
+## User specific acknowledgments
 
 You may need to create custom notices that are shown to and can only be acknowledged by a specific subset of users. To accomplish this, specify an `allowList` array of UIDs to the notice document. If the user requesting a notice by type is not within the list of UIDs, a `not-found` error will be returned.
 
 ## Updating a notice
 
 When it's time to update a notice, for example when additional user preferences are required, create a new notice document with the same `type` as the existing notice you wish to update.
 
-When the notice is retrieved, a new notice document will be returned with no user acknowledgement, allowing users to acknowledge the newer notice.
+When the notice is retrieved, a new notice document will be returned with no acknowledgment, allowing users to acknowledge the newer notice.

docs/record-user-acknowledgements/index.mdx renamed to docs/firestore-record-acknowledgments/index.mdx

@@ -1,6 +1,6 @@
 # API Reference
 
-Below contains an overview of the specifications for the Record User Acknowledgements extension, including TypeScript definitions & detailed descriptions.
+Below contains an overview of the specifications for the Firestore Record Acknowledgments extension, including TypeScript definitions & detailed descriptions.
 
 ## `NoticeDocument` Interface
 
@@ -27,12 +27,12 @@ export interface NoticeDocument {
 }
 ```
 
-## `AcknowledgementDocument` Interface
+## `AcknowledgmentDocument` Interface
 
 The specification for a single document within a notice sub-collection:
 
 ```ts
-type BaseAcknowledgement = {
+type BaseAcknowledgment = {
   // The document ID.
   id: string;
   // The UID of the user who acknowledged the notice.
@@ -41,19 +41,19 @@ type BaseAcknowledgement = {
   noticeId: string;
   // The timestamp when the notice was acknowledged.
   createdAt: Timestamp;
-  // The optional metadata of the acknowledgement.
+  // The optional metadata of the acknowledgment.
   metadata: any;
 };
 
-export type AcknowledgementDocument =
-  | (BaseAcknowledgement & {
-      // The type of the acknowledgement.
+export type AcknowledgmentDocument =
+  | (BaseAcknowledgment & {
+      // The type of the acknowledgment.
       ackEvent: 'acknowledged';
-      // The type of the acknowledgement. Defaults to `seen`.
+      // The type of the acknowledgment. Defaults to `seen`.
       type: string;
     })
-  | (BaseAcknowledgement & {
-      // The type of the acknowledgement.
+  | (BaseAcknowledgment & {
+      // The type of the acknowledgment.
       ackEvent: 'unacknowledged';
     });
 ```
@@ -80,8 +80,8 @@ export type GetNoticeResponse = Omit<NoticeDocument, ‘allowList’> & {
  // The timestamp when the notice was unacknowledged by the user (undefined if the user has not unacknowledged this notice).
  unacknowledgedAt?: Timestamp;
 
- // An ordered array of user acknowledgements.
- acknowledgements: AcknowledgementDocument[];
+ // An ordered array of acknowledgments.
+ acknowledgments: AcknowledgmentDocument[];
 }
 ```
 
@@ -93,9 +93,9 @@ The response interface provided to a `acknowledgeNotice` callable function:
 export interface AcknowledgeNoticeRequest {
   // The notice ID to acknowledge.
   noticeId: string;
-  // A custom type to provide as the acknowledgement. Defaults to `seen`.
+  // A custom type to provide as the acknowledgment. Defaults to `seen`.
   type?: string;
-  // Optional preference metadata to store with this acknowledgement.
+  // Optional preference metadata to store with this acknowledgment.
   metadata?: any;
 }
 ```
@@ -108,29 +108,29 @@ The response interface provided to a `unacknowledgeNotice` callable function:
 export interface UnacknowledgeNoticeRequest {
   // The notice ID to unacknowledge.
   noticeId: string;
-  // Optional preference metadata to store with this unacknowledgement.
+  // Optional preference metadata to store with this unacknowledgment.
   metadata?: any;
 }
 ```
 
-## `GetAcknowledgementsRequest` Interface
+## `GetAcknowledgmentsRequest` Interface
 
-The response interface provided to a `getAcknowledgements` callable function:
+The response interface provided to a `getAcknowledgments` callable function:
 
 ```ts
-export interface GetAcknowledgementsRequest {
-  // If true, include unacknowledgement documents.
-  includeUnacknowledgements?: boolean;
+export interface GetAcknowledgmentsRequest {
+  // If true, include unacknowledgment documents.
+  includeUnacknowledgments?: boolean;
 }
 ```
 
-## `GetAcknowledgementsResponse` Interface
+## `GetAcknowledgmentsResponse` Interface
 
-The response interface provided to a `getAcknowledgements` callable function:
+The response interface provided to a `getAcknowledgments` callable function:
 
 ```ts
-export type GetAcknowledgementsResponse  = (AcknowledgementDocument & {
-  // The notice of this acknowledgement, excluding the allowList.
+export type GetAcknowledgmentsResponse  = (AcknowledgmentDocument & {
+  // The notice of this acknowledgment, excluding the allowList.
   notice: Omit<NoticeDocument, ‘allowList’>;
 })[];
 ```

docs/record-user-acknowledgements/reference.mdx renamed to docs/firestore-record-acknowledgments/reference.mdx

@@ -6,7 +6,7 @@
   <h2 align="center">Invertase Firebase Extensions</h2>
 </p>
 
-| Name                                                          |                                  Description                                   |
-| ------------------------------------------------------------- | :----------------------------------------------------------------------------: |
-| [Image Processing Api](/image-processing-api)                 |        Firebase deployed function for processing and rendering images.         |
-| [Record User Acknowledgements](/record-user-acknowledgements) | Provides an out of the box acknowledgement management extension for Firestore. |
+| Name                                                                  |                                  Description                                  |
+| --------------------------------------------------------------------- | :---------------------------------------------------------------------------: |
+| [Image Processing Api](/image-processing-api)                         |        Firebase deployed function for processing and rendering images.        |
+| [Firestore Record Acknowledgments](/firestore-record-acknowledgments) | Provides an out of the box acknowledgment management extension for Firestore. |