@unaffi/schema 1.1.3 → 1.1.4

package/README.md

@@ -14,6 +14,9 @@ Example:
 ```js
 /** @type {import('@unaffi/schema').Profile} */
 const profile = await getProfile();
+
+/** @type {import('@unaffi/schema').Profile[]} */
+const dependants = await getDependants();
 ```
 
 or define it at the top of the page to use the type throughout the file:
@@ -22,15 +25,32 @@ or define it at the top of the page to use the type throughout the file:
 
 /** @type {Profile} */
 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();
+
+/** @type {Profile[]} */
+const dependants = await getDependants();
+```
+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
   {
-    // …
-    "version": "1.0.0", // to "1.0.1"   |   Always update 3rd number, unless it is a large update (such as an extra table added). Never update 1st number unless we restart unaffi's schema entirely.
-    // …
+    // …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. Update **Github**:

package/collections/favourite.schema.ts

@@ -0,0 +1,20 @@
+import type { Base } from "../base.schema";
+import type * as DB from "../index";
+
+export interface Favourite extends Base {
+  readonly file_id: string;
+
+  is_unfavourite: boolean;
+
+  profile_id: DB.Profile["profile_id"];
+  profile?: DB.Profile;
+
+  org_id?: DB.Org["org_id"];
+  org?: DB.Org;
+
+  service_id?: DB.Service["service_id"];
+  service?: DB.Service;
+
+  location_id?: DB.Location["location_id"];
+  location?: DB.Location;
+}

package/collections/profile.schema.d.ts

@@ -23,7 +23,6 @@ export interface Profile extends Base {
 		profile_pic_file_id?: string;
 		cover_pic_file_id?: string;
 
-		is_dependant: boolean;
 		relationship_to_owner?: string;
 		contact_method: {
 			email?: boolean;

package/index.d.ts

@@ -2,6 +2,7 @@ export * from "./collections/action.schema";
 export * from "./collections/collaborator.schema";
 export * from "./collections/contactpoint.schema";
 export * from "./collections/facility.schema";
+export * from "./collections/favourite.schema";
 export * from "./collections/file.schema";
 export * from "./collections/form.schema";
 export * from "./collections/instance.schema";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unaffi/schema",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "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": {