@dereekb/model 13.9.0 → 13.10.1

package/index.cjs.js

@@ -2327,6 +2327,7 @@ function _async_to_generator$1(fn) {
     };
 }
 function _instanceof(left, right) {
+    "@swc/helpers - instanceof";
     if (right != null && typeof Symbol !== "undefined" && right[Symbol.hasInstance]) {
         return !!right[Symbol.hasInstance](left);
     } else {

package/index.esm.js

@@ -2325,6 +2325,7 @@ function _async_to_generator$1(fn) {
     };
 }
 function _instanceof(left, right) {
+    "@swc/helpers - instanceof";
     if (right != null && typeof Symbol !== "undefined" && right[Symbol.hasInstance]) {
         return !!right[Symbol.hasInstance](left);
     } else {

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@dereekb/model",
-  "version": "13.9.0",
+  "version": "13.10.1",
   "peerDependencies": {
-    "@dereekb/util": "13.9.0",
+    "@dereekb/util": "13.10.1",
     "arktype": "^2.2.0",
-    "make-error": "^1.3.0"
+    "make-error": "^1.3.6"
   },
   "exports": {
     "./package.json": "./package.json",

package/src/lib/data/website/link.d.ts

@@ -31,6 +31,10 @@ export declare const WEBSITE_LINK_TYPE_REGEX: RegExp;
 export declare function isValidWebsiteLinkType(input: string): input is WebsiteLinkType;
 /**
  * Pipe-separated or raw string encoding of website link data.
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic dereekb-model:website-link
  */
 export type WebsiteLinkEncodedData = string;
 /**

package/src/lib/data/website/link.file.d.ts

@@ -14,6 +14,10 @@ export declare const WEBSITE_FILE_LINK_TYPE_MAX_LENGTH = 32;
 export declare const WEBSITE_FILE_LINK_TYPE_REGEX: RegExp;
 /**
  * MIME type string for a file link (e.g., "image/png", "application/pdf").
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic dereekb-model:website-link
  */
 export type WebsiteFileLinkMimeType = string;
 /**
@@ -26,6 +30,10 @@ export declare const WEBSITE_FILE_LINK_MIME_TYPE_MAX_LENGTH = 128;
 export declare const WEBSITE_FILE_LINK_MIME_TYPE_REGEX: RegExp;
 /**
  * Display name for a file link. Has no pattern restriction.
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic dereekb-model:website-link
  */
 export type WebsiteFileLinkName = string;
 /**
@@ -34,6 +42,10 @@ export type WebsiteFileLinkName = string;
 export declare const WEBSITE_FILE_LINK_NAME_MAX_LENGTH = 128;
 /**
  * The data payload of a file link, typically a URL pointing to the file.
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic dereekb-model:website-link
  */
 export type WebsiteFileLinkData = string;
 /**

package/src/lib/data/website/link.website.d.ts

@@ -100,6 +100,14 @@ export declare const FACEBOOK_BASE_URL = "https://www.facebook.com";
 export declare const FACEBOOK_WEBSITE_LINK_TYPE: WebsiteLinkType;
 export type FacebookBaseUrl = typeof FACEBOOK_BASE_URL;
 export type FacebookProfileUrl<P extends FacebookProfileId> = `${FacebookBaseUrl}/${P}`;
+/**
+ * Facebook profile identifier.
+ *
+ * @semanticType
+ * @semanticTopic identifier
+ * @semanticTopic string
+ * @semanticTopic dereekb-model:social
+ */
 export type FacebookProfileId = string;
 export type FacebookWebsiteLinkType = typeof FACEBOOK_WEBSITE_LINK_TYPE;
 /**
@@ -137,6 +145,14 @@ export declare const INSTAGRAM_BASE_URL = "https://www.instagram.com";
 export declare const INSTAGRAM_WEBSITE_LINK_TYPE: WebsiteLinkType;
 export type InstagramBaseUrl = typeof INSTAGRAM_BASE_URL;
 export type InstagramProfileUrl<P extends InstagramProfileId> = `${InstagramBaseUrl}/${P}`;
+/**
+ * Instagram profile identifier.
+ *
+ * @semanticType
+ * @semanticTopic identifier
+ * @semanticTopic string
+ * @semanticTopic dereekb-model:social
+ */
 export type InstagramProfileId = string;
 export type InstagramWebsiteLinkType = typeof INSTAGRAM_WEBSITE_LINK_TYPE;
 /**
@@ -163,6 +179,14 @@ export declare const TWITTER_BASE_URL = "https://www.twitter.com";
 export declare const TWITTER_WEBSITE_LINK_TYPE: WebsiteLinkType;
 export type TwitterBaseUrl = typeof TWITTER_BASE_URL;
 export type TwitterProfileUrl<P extends TwitterProfileId> = `${TwitterBaseUrl}/${P}`;
+/**
+ * Twitter/X profile identifier.
+ *
+ * @semanticType
+ * @semanticTopic identifier
+ * @semanticTopic string
+ * @semanticTopic dereekb-model:social
+ */
 export type TwitterProfileId = string;
 export type TwitterWebsiteLinkType = typeof TWITTER_WEBSITE_LINK_TYPE;
 /**
@@ -193,6 +217,14 @@ export declare const TIKTOK_USERNAME_PREFIX = "@";
 export declare const TIKTOK_WEBSITE_LINK_TYPE: WebsiteLinkType;
 export type TikTokBaseUrl = typeof TIKTOK_BASE_URL;
 export type TikTokProfileUrl<P extends TikTokProfileId> = `${TikTokBaseUrl}/@${P}`;
+/**
+ * TikTok profile identifier.
+ *
+ * @semanticType
+ * @semanticTopic identifier
+ * @semanticTopic string
+ * @semanticTopic dereekb-model:social
+ */
 export type TikTokProfileId = string;
 export type TikTokWebsiteLinkType = typeof TIKTOK_WEBSITE_LINK_TYPE;
 /**
@@ -221,6 +253,14 @@ export declare const SNAPCHAT_BASE_URL = "https://snapchat.com";
 export declare const SNAPCHAT_WEBSITE_LINK_TYPE: WebsiteLinkType;
 export type SnapchatBaseUrl = typeof SNAPCHAT_BASE_URL;
 export type SnapchatProfileUrl<P extends SnapchatProfileId> = `${SnapchatBaseUrl}/add/${P}`;
+/**
+ * Snapchat profile identifier.
+ *
+ * @semanticType
+ * @semanticTopic identifier
+ * @semanticTopic string
+ * @semanticTopic dereekb-model:social
+ */
 export type SnapchatProfileId = string;
 export type SnapchatWebsiteLinkType = typeof SNAPCHAT_WEBSITE_LINK_TYPE;
 /**
@@ -253,6 +293,14 @@ export declare const YOUTUBE_BASE_URL = "https://youtube.com";
 export declare const YOUTUBE_WEBSITE_LINK_TYPE: WebsiteLinkType;
 export type YouTubeBaseUrl = typeof YOUTUBE_BASE_URL;
 export type YouTubeProfileUrl<P extends YouTubeProfileId> = `${YouTubeBaseUrl}/c/${P}`;
+/**
+ * YouTube profile identifier.
+ *
+ * @semanticType
+ * @semanticTopic identifier
+ * @semanticTopic string
+ * @semanticTopic dereekb-model:social
+ */
 export type YouTubeProfileId = string;
 export type YouTubeWebsiteLinkType = typeof YOUTUBE_WEBSITE_LINK_TYPE;
 /**
@@ -285,6 +333,14 @@ export declare const PAYPAL_BASE_URL = "https://paypal.me";
 export declare const PAYPAL_WEBSITE_LINK_TYPE: WebsiteLinkType;
 export type PayPalBaseUrl = typeof PAYPAL_BASE_URL;
 export type PayPalProfileUrl<P extends PayPalProfileId> = `${PayPalBaseUrl}/${P}`;
+/**
+ * PayPal profile identifier.
+ *
+ * @semanticType
+ * @semanticTopic identifier
+ * @semanticTopic string
+ * @semanticTopic dereekb-model:social
+ */
 export type PayPalProfileId = string;
 export type PayPalWebsiteLinkType = typeof PAYPAL_WEBSITE_LINK_TYPE;
 /**
@@ -315,6 +371,14 @@ export declare const CASHAPP_USERNAME_PREFIX = "$";
 export declare const CASHAPP_WEBSITE_LINK_TYPE: WebsiteLinkType;
 export type CashappBaseUrl = typeof CASHAPP_BASE_URL;
 export type CashappProfileUrl<P extends CashappProfileId> = `${CashappBaseUrl}/$${P}`;
+/**
+ * Cash App profile identifier.
+ *
+ * @semanticType
+ * @semanticTopic identifier
+ * @semanticTopic string
+ * @semanticTopic dereekb-model:social
+ */
 export type CashappProfileId = string;
 export type CashappWebsiteLinkType = typeof CASHAPP_WEBSITE_LINK_TYPE;
 /**
@@ -343,6 +407,14 @@ export declare const VENMO_BASE_URL = "https://account.venmo.com";
 export declare const VENMO_WEBSITE_LINK_TYPE: WebsiteLinkType;
 export type VenmoBaseUrl = typeof VENMO_BASE_URL;
 export type VenmoProfileUrl<P extends VenmoProfileId> = `${VenmoBaseUrl}/u/${P}`;
+/**
+ * Venmo profile identifier.
+ *
+ * @semanticType
+ * @semanticTopic identifier
+ * @semanticTopic string
+ * @semanticTopic dereekb-model:social
+ */
 export type VenmoProfileId = string;
 export type VenmoWebsiteLinkType = typeof VENMO_WEBSITE_LINK_TYPE;
 /**
@@ -375,6 +447,14 @@ export declare const SPOTIFY_BASE_URL = "https://open.spotify.com/";
 export declare const SPOTIFY_WEBSITE_LINK_TYPE: WebsiteLinkType;
 export type SpotifyBaseUrl = typeof SPOTIFY_BASE_URL;
 export type SpotifyProfileUrl<P extends SpotifyProfileId> = `${SpotifyBaseUrl}/user/${P}`;
+/**
+ * Spotify profile identifier.
+ *
+ * @semanticType
+ * @semanticTopic identifier
+ * @semanticTopic string
+ * @semanticTopic dereekb-model:social
+ */
 export type SpotifyProfileId = string;
 export type SpotifyWebsiteLinkType = typeof SPOTIFY_WEBSITE_LINK_TYPE;
 /**

package/src/lib/service/permission/role.d.ts

@@ -1,6 +1,11 @@
 import { type ArrayOrValue, type IterableOrValue, type Maybe, type SetIncludesMode } from '@dereekb/util';
 /**
  * A granted role for a model.
+ *
+ * @semanticType
+ * @semanticTopic identifier
+ * @semanticTopic string
+ * @semanticTopic dereekb-model:auth
  */
 export type GrantedRole = string;
 /**

package/src/lib/service/sync/sync.entity.d.ts

@@ -2,16 +2,31 @@ import { type FactoryWithRequiredInput, type Maybe, type UniqueModel } from '@de
 import { type SyncSourceInfo } from './sync.source';
 /**
  * A unique identifier for an entity on a specific server.
+ *
+ * @semanticType
+ * @semanticTopic identifier
+ * @semanticTopic string
+ * @semanticTopic dereekb-model:sync
  */
 export type SyncEntityId = string;
 /**
  * A common type for an entity that is shared/used between all systems for an entity that should be synchronized.
+ *
+ * @semanticType
+ * @semanticTopic identifier
+ * @semanticTopic string
+ * @semanticTopic dereekb-model:sync
  */
 export type SyncEntityCommonType = string;
 /**
  * A common identifier for an entity that is shared/used between all systems for an entity that should be synchronized.
  *
  * This identifier should be used for retrieving a similar entity from any server.
+ *
+ * @semanticType
+ * @semanticTopic identifier
+ * @semanticTopic string
+ * @semanticTopic dereekb-model:sync
  */
 export type SyncEntityCommonId = string;
 /**

package/src/lib/service/sync/sync.source.d.ts

@@ -2,10 +2,19 @@
  * English name for a SyncSource.
  *
  * Is not used as a key.
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic dereekb-model:sync
  */
 export type SyncSourceName = string;
 /**
  * A unique identifier for a SyncSource.
+ *
+ * @semanticType
+ * @semanticTopic identifier
+ * @semanticTopic string
+ * @semanticTopic dereekb-model:sync
  */
 export type SyncSourceId = string;
 /**