@unaffi/schema 1.1.4 → 1.1.5

package/README.md

@@ -5,12 +5,15 @@ This reflects what the API returns, **not** what the DB Schema looks like in Mon
 Can be imported into any repo and be used by both TS and JS (JSDocs) code.
 
 ## Installation
+
 ```bash
 npm i --save-dev @unaffi/schema
 ```
 
 ## Usage
+
 Example:
+
 ```js
 /** @type {import('@unaffi/schema').Profile} */
 const profile = await getProfile();
@@ -20,6 +23,7 @@ const dependants = await getDependants();
 ```
 
 or define it at the top of the page to use the type throughout the file:
+
 ```js
 /** @typedef {import('@unaffi/schema').Profile} Profile */
 
@@ -29,11 +33,15 @@ const profile = await getProfile();
 /** @type {Profile[]} */
 const dependants = await getDependants();
 ```
+
 or define it in a `types/index.js` file (where the file directory, `types`, is a peer directory or the peer of a parent directory of the file you will be using it).
+
 ```js
 /** @typedef {import('@unaffi/schema').Profile} Profile */
 ```
+
 and then in the svelte file you need it:
+
 ```js
 /** @type {Profile} */
 const profile = await getProfile();
@@ -41,26 +49,53 @@ const profile = await getProfile();
 /** @type {Profile[]} */
 const dependants = await getDependants();
 ```
-NOTE: This 3rd option only works in Svelte Projects – I believe in vite projects.
 
+NOTE: This 3rd option only works in Svelte Projects – I believe in vite projects.
 
 ## Updating the Schema
+
 1. **Bump the version** in the `package.json`:
-  ```jsonc
-  {
-    // …existing code…
-    "version": "1.0.0", // to "1.0.1"   |   Always update 3rd number, unless it is a large update (such as an extra collection added). Never update 1st number unless we restart unaffi's schema entirely.
-    // …existing code…
-  } 
+
+```jsonc
+{
+  // …existing code…
+  "version": "1.0.0" // to "1.0.1"   |   Always update 3rd number, unless it is a large update (such as an extra collection added). Never update 1st number unless we restart unaffi's schema entirely.
+  // …existing code…
+}
+```
+
+2. **Create authentication token** (one-time setup):
+
+   - Go to https://www.npmjs.com/settings/YOUR_USERNAME/tokens
+   - Click "Generate New Token" → Select **"Granular Access Token"**
+   - Give it a name (e.g., "publish-token")
+   - Under **Packages and scopes**:
+     - Permissions: Select **Read and write**
+     - Packages: Select the `@unaffi/schema` package (or "All packages")
+   - **Important:** Check the **"Bypass 2FA"** option
+   - Click "Generate Token" and copy the token
+
+   Create a `.npmrc` file in the project root with:
+
+   ```ini
+   //registry.npmjs.org/:_authToken=YOUR_TOKEN_HERE
+   ```
+
+   Replace `YOUR_TOKEN_HERE` with the token you just copied.
+
+   **Security Note:** Do not commit the `.npmrc` file content. It is in the `.gitignore` file.
+
+3. Update **Github**:
+
+```bash
+git add .
+git commit -m "Your commit message"
+git push
+```
+
+4. Update **npm**:
+
+```bash
+npm login
+npm publish --access public
 ```
-2. Update **Github**:
-  ```bash
-  git add .
-  git commit -m "Your commit message"
-  git push
-  ```
-3. Update **npm**:
-  ```bash
-  npm login
-  npm publish --access public
-  ```

package/collections/favourite.schema.ts

@@ -2,9 +2,9 @@ import type { Base } from "../base.schema";
 import type * as DB from "../index";
 
 export interface Favourite extends Base {
-  readonly file_id: string;
+  readonly favourite_id: string;
 
-  is_unfavourite: boolean;
+  is_unfavourited: boolean;
 
   profile_id: DB.Profile["profile_id"];
   profile?: DB.Profile;
@@ -15,6 +15,9 @@ export interface Favourite extends Base {
   service_id?: DB.Service["service_id"];
   service?: DB.Service;
 
+  schedule_id?: DB.Schedule["schedule_id"];
+  schedule?: DB.Schedule;
+
   location_id?: DB.Location["location_id"];
   location?: DB.Location;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unaffi/schema",
-  "version": "1.1.4",
+  "version": "1.1.5",
   "description": "This reflects what the API returns, and not what the DB Schema looks like in MongoDB. Can be imported into any repo and be used by both TS and JS (JSDocs) code.",
   "types": "index.d.ts",
   "scripts": {