@chainfuse/types 0.0.1-beta.0

package/README.md

@@ -0,0 +1,11 @@
+# `@chainfuse/types`
+
+> TODO: description
+
+## Usage
+
+```
+import types from '@chainfuse/types';
+
+// TODO: DEMONSTRATE API
+```

package/dist/d1/dataspaces/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * It is used to carry over the types when using the `Object.values()` method.
+ */
+export type ObjectValues<T> = {
+    [K in keyof T]: T[K];
+} extends Record<string, infer U> ? U[] : never;
+export type ExtractKeysWithPrefix<T, Prefix extends string> = {
+    [K in keyof T]: K extends `${Prefix}${string}` ? K : never;
+}[keyof T];
+export type FilterKeysWithPrefix<T, Prefix extends string> = {
+    [K in keyof T as K extends `${Prefix}${string}` ? K : never]: T[K];
+};
+export type FilterKeysWithPrefixAndPrepend<T, Prefix extends string, Prepend extends string> = {
+    [K in keyof T as K extends `${Prefix}${string}` ? `${Prepend}${K}` : never]: T[K];
+};

package/dist/d1/index.d.ts

@@ -0,0 +1,10 @@
+import type { Buffer } from 'node:buffer';
+export * from './dataspaces/index.js';
+export * from './users/index.js';
+export type PrefixedUuid = `${'t_' | 'd_' | 'u_'}${UuidExport['utf8']}${'' | '_p'}`;
+export interface UuidExport {
+    utf8: ReturnType<typeof crypto.randomUUID>;
+    hex: string;
+    blob: (typeof Uint8Array)['prototype']['buffer'] | Buffer['buffer'];
+}
+export type ISODateString = `${number}-${number}-${number}T${number}:${number}:${number}.${number}Z`;

package/dist/d1/users/index.d.ts

@@ -0,0 +1 @@
+export type EmailAddress = `${string}@${string}.${string}`;

package/dist/discourse/index.d.ts

@@ -0,0 +1,2 @@
+export * from './post/index.js';
+export * from './topic/index.js';

package/dist/discourse/post/index.d.ts

@@ -0,0 +1,66 @@
+export declare enum PostEvents {
+    created = "post_created",
+    edited = "post_edited",
+    destroyed = "post_destroyed",
+    recovered = "post_recovered"
+}
+export interface TopicPost extends Record<string, any> {
+    id: number;
+    name: string;
+    username: string;
+    avatar_template: string;
+    created_at: ReturnType<Date['toISOString']>;
+    cooked: string;
+    post_number: number;
+    post_type: number;
+    updated_at: ReturnType<Date['toISOString']>;
+    reply_count: number;
+    reply_to_post_number: string | null;
+    quote_count: number;
+    incoming_link_count: number;
+    reads: number;
+    readers_count: number;
+    score: number;
+    yours: boolean;
+    topic_id: number;
+    topic_slug: string;
+    display_username: string;
+    flair_name: string | null;
+    flair_url: string | null;
+    flair_bg_color: string | null;
+    flair_color: string | null;
+    version: number;
+    can_edit: boolean;
+    can_delete: boolean;
+    can_recover: boolean;
+    can_see_hidden_post?: boolean;
+    can_wiki: boolean;
+    link_counts: {
+        url: string;
+        internal: boolean;
+        reflection: boolean;
+        title: string;
+        clicks: number;
+    }[];
+    read: boolean;
+    user_title: string | null;
+    bookmarked: boolean;
+    actions_summary: {
+        id: number;
+        can_act: boolean;
+    }[];
+    moderator: boolean;
+    admin: boolean;
+    staff: boolean;
+    user_id: number;
+    hidden: boolean;
+    trust_level: number;
+    deleted_at: ReturnType<Date['toISOString']>;
+    user_deleted: boolean;
+    edit_reason: string | null;
+    can_view_edit_history: number;
+    wiki: boolean;
+    reviewable_id: number;
+    reviewable_score_count: number;
+    reviewable_score_pending_count: number;
+}

package/dist/discourse/topic/index.d.ts

@@ -0,0 +1,120 @@
+import type { TopicPost } from '../post/index.js';
+export declare enum TopicEvents {
+    created = "topic_created",
+    revised = "topic_revised",
+    edited = "topic_edited",
+    destroyed = "topic_destroyed",
+    recovered = "topic_recovered"
+}
+export interface TopicCollections extends Record<string, any> {
+    topic_list: TopicList;
+}
+interface TopicList extends Record<string, any> {
+    topics: Topic[];
+}
+export interface TopicUser {
+    id: number;
+    username: string;
+    name: string;
+    avatar_template: string;
+}
+export interface Topic extends Record<string, any> {
+    post_stream: {
+        posts: TopicPost[];
+        stream: any[];
+    };
+    suggested_topics: Record<string, any>[];
+    timeline_lookup: any[];
+    tags_descriptions: Record<string, any>;
+    id: number;
+    title: string;
+    fancy_title: string;
+    posts_count: number;
+    created_at: ReturnType<Date['toISOString']>;
+    views: number;
+    reply_count: number;
+    like_count: number;
+    last_posted_at: ReturnType<Date['toISOString']>;
+    visible: boolean;
+    closed: boolean;
+    archived: boolean;
+    has_summary: boolean;
+    archetype: string;
+    slug: string;
+    category_id: number;
+    word_count: number | null;
+    deleted_at: ReturnType<Date['toISOString']> | null;
+    user_id: number;
+    featured_link: string | null;
+    pinned_globally: boolean;
+    pinned_at: ReturnType<Date['toISOString']> | null;
+    pinned_until: ReturnType<Date['toISOString']> | null;
+    image_url: string | null;
+    slow_mode_seconds: number;
+    draft: string | null;
+    draft_key: string;
+    draft_sequence: number;
+    unpinned: string | null;
+    pinned: boolean;
+    current_post_number: number;
+    highest_post_number: number | null;
+    deleted_by: ReturnType<Date['toISOString']> | null;
+    has_deleted: number;
+    actions_summary: {
+        id: number;
+        count: number;
+        hidden: boolean;
+        can_act: boolean;
+    }[];
+    chunk_size: number;
+    bookmarked: boolean;
+    bookmarks: any[];
+    topic_timer: string | null;
+    message_bus_last_id: number;
+    participant_count: number;
+    show_read_indicator: boolean;
+    thumbnails: string | null;
+    slow_mode_enabled_until: string | null;
+    summarizable: boolean;
+    details: {
+        can_edit: boolean;
+        notification_level: number;
+        can_move_posts: boolean;
+        can_delete: boolean;
+        can_remove_allowed_users: boolean;
+        can_create_post: boolean;
+        can_reply_as_new_topic: boolean;
+        can_invite_to?: boolean;
+        can_invite_via_email?: boolean;
+        can_flag_topic?: boolean;
+        can_convert_topic: boolean;
+        can_review_topic: boolean;
+        can_close_topic: boolean;
+        can_archive_topic: boolean;
+        can_split_merge_topic: boolean;
+        can_edit_staff_notes: boolean;
+        can_toggle_topic_visibility: boolean;
+        can_pin_unpin_topic: boolean;
+        can_moderate_category: boolean;
+        can_remove_self_id: boolean;
+        participants?: {
+            id: number;
+            username: string;
+            name: string;
+            avatar_template: string;
+            post_count: number;
+            primary_group_name: string | null;
+            flair_name: string | null;
+            flair_url: string | null;
+            flair_color: string | null;
+            flair_bg_color: string | null;
+            flair_group_id: string | null;
+            admin: boolean;
+            moderator: boolean;
+            trust_level: number;
+        }[];
+        created_by: TopicUser;
+        last_poster: TopicUser;
+    };
+}
+export {};

package/dist/index.d.ts

@@ -0,0 +1,38 @@
+export * from './d1/index.js';
+export * from './discourse/index.js';
+type MethodKeys<T> = {
+    [P in keyof T]: T[P] extends (...args: any[]) => any ? P : never;
+}[keyof T];
+export type JsonParsed<T> = Omit<T, MethodKeys<T>>;
+/**
+ * This type is similar to the built-in `Partial<>` type, but it applies recursively to nested objects and arrays.
+ * If a property is an array, the elements of the array will also be recursively made optional.
+ * If a property is an object, the properties of the object will also be recursively made optional.
+ */
+export type RecursivePartial<T> = {
+    [P in keyof T]?: T[P] extends (infer U)[] ? RecursivePartial<U>[] : T[P] extends object ? RecursivePartial<T[P]> : T[P];
+};
+/**
+ * Returns the union of keys from a given type.
+ */
+export type UnionKeys<T> = T extends any ? keyof T : never;
+/**
+ * Defines a type that excludes specific keys from an object type.
+ */
+export type BlockKeys<T, K extends readonly string[]> = {
+    [P in keyof T as P extends K[number] ? never : P]: T[P];
+};
+export type PromiseFactory<T> = () => Promise<T>;
+export interface ExternallyResolvablePromise<T> {
+    promise: Promise<T>;
+    resolve: (value: T) => void;
+    reject: (reason?: any) => void;
+}
+/**
+ * Mark every property of an object as undefined.
+ */
+export type UndefinedProperties<T extends object> = {
+    [P in keyof T]: undefined;
+};
+export type CustomLogCallback = (message: string) => void;
+export type CustomLoging = boolean | CustomLogCallback;

package/package.json

@@ -0,0 +1,72 @@
+{
+	"name": "@chainfuse/types",
+	"version": "0.0.1-beta.0",
+	"description": "",
+	"author": "ChainFuse",
+	"homepage": "https://github.com/ChainFuse/packages/tree/main/packages/types#readme",
+	"license": "Apache-2.0",
+	"main": "./dist/index.js",
+	"directories": {
+		"lib": "dist"
+	},
+	"files": [
+		"dist"
+	],
+	"publishConfig": {
+		"access": "public"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/ChainFuse/packages.git"
+	},
+	"scripts": {
+		"fmt": "prettier --check .",
+		"fmt:fix": "prettier --write .",
+		"lint": "eslint .",
+		"lint:fix": "npm run lint -- --fix",
+		"build": "tsc",
+		"build:clean": "npm run build -- --build --clean && npm run build"
+	},
+	"type": "module",
+	"bugs": {
+		"url": "https://github.com/ChainFuse/packages/issues"
+	},
+	"types": "./dist/index.d.ts",
+	"engines": {
+		"node": ">=20.16.0"
+	},
+	"exports": {
+		".": {
+			"import": "./dist/index.js",
+			"types": "./dist/index.d.ts"
+		},
+		"./d1": {
+			"import": "./dist/d1/index.js",
+			"types": "./dist/d1/index.d.ts"
+		},
+		"./d1/dataspaces": {
+			"import": "./dist/d1/dataspaces/index.js",
+			"types": "./dist/d1/dataspaces/index.d.ts"
+		},
+		"./d1/users": {
+			"import": "./dist/d1/users/index.js",
+			"types": "./dist/d1/users/index.d.ts"
+		},
+		"./discourse": {
+			"import": "./dist/discourse/index.js",
+			"types": "./dist/discourse/index.d.ts"
+		},
+		"./discourse/post": {
+			"import": "./dist/discourse/post/index.js",
+			"types": "./dist/discourse/post/index.d.ts"
+		},
+		"./discourse/topic": {
+			"import": "./dist/discourse/topic/index.js",
+			"types": "./dist/discourse/topic/index.d.ts"
+		}
+	},
+	"prettier": "@demosjarco/prettier-config",
+	"dependencies": {},
+	"devDependencies": {},
+	"optionalDependencies": {}
+}