@atcute/pckt 0.1.0

package/lib/lexicons/types/blog/pckt/document.ts

@@ -0,0 +1,124 @@
+import type {} from '@atcute/lexicons';
+import * as v from '@atcute/lexicons/validations';
+import type {} from '@atcute/lexicons/ambient';
+import * as BlogPcktBlockBlockquote from './block/blockquote.js';
+import * as BlogPcktBlockBlueskyEmbed from './block/blueskyEmbed.js';
+import * as BlogPcktBlockBulletList from './block/bulletList.js';
+import * as BlogPcktBlockCodeBlock from './block/codeBlock.js';
+import * as BlogPcktBlockHeading from './block/heading.js';
+import * as BlogPcktBlockHorizontalRule from './block/horizontalRule.js';
+import * as BlogPcktBlockImage from './block/image.js';
+import * as BlogPcktBlockListItem from './block/listItem.js';
+import * as BlogPcktBlockOrderedList from './block/orderedList.js';
+import * as BlogPcktBlockParagraph from './block/paragraph.js';
+import * as BlogPcktBlockTaskItem from './block/taskItem.js';
+import * as BlogPcktBlockTaskList from './block/taskList.js';
+import * as ComAtprotoRepoStrongRef from '@atcute/atproto/types/repo/strongRef';
+
+const _mainSchema = /*#__PURE__*/ v.record(
+	/*#__PURE__*/ v.tidString(),
+	/*#__PURE__*/ v.object({
+		$type: /*#__PURE__*/ v.literal('blog.pckt.document'),
+		/**
+		 * Structured content blocks composing the document body
+		 */
+		get blocks() {
+			return /*#__PURE__*/ v.array(
+				/*#__PURE__*/ v.variant([
+					BlogPcktBlockBlockquote.mainSchema,
+					BlogPcktBlockBlueskyEmbed.mainSchema,
+					BlogPcktBlockBulletList.mainSchema,
+					BlogPcktBlockCodeBlock.mainSchema,
+					BlogPcktBlockHeading.mainSchema,
+					BlogPcktBlockHorizontalRule.mainSchema,
+					BlogPcktBlockImage.mainSchema,
+					BlogPcktBlockListItem.mainSchema,
+					BlogPcktBlockOrderedList.mainSchema,
+					BlogPcktBlockParagraph.mainSchema,
+					BlogPcktBlockTaskItem.mainSchema,
+					BlogPcktBlockTaskList.mainSchema,
+				]),
+			);
+		},
+		/**
+		 * Plain text representation of the document content for search and preview
+		 * @maxLength 100000
+		 * @maxGraphemes 50000
+		 */
+		bodyPlain: /*#__PURE__*/ v.optional(
+			/*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [
+				/*#__PURE__*/ v.stringLength(0, 100000),
+				/*#__PURE__*/ v.stringGraphemes(0, 50000),
+			]),
+		),
+		/**
+		 * Optional cover/featured image (10MB max)
+		 * @accept image/*
+		 * @maxSize 10000000
+		 */
+		cover: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.blob()),
+		/**
+		 * Blob references for images used within the document content
+		 */
+		images: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.array(/*#__PURE__*/ v.blob())),
+		/**
+		 * Reference to the parent publication this document belongs to
+		 */
+		get publication() {
+			return ComAtprotoRepoStrongRef.mainSchema;
+		},
+		/**
+		 * Timestamp when the document was first published
+		 */
+		publishedAt: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.datetimeString()),
+		/**
+		 * URL-friendly slug for the document (used to construct canonical URL)
+		 * @maxLength 500
+		 */
+		slug: /*#__PURE__*/ v.optional(
+			/*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [/*#__PURE__*/ v.stringLength(0, 500)]),
+		),
+		/**
+		 * Optional tags for categorization and discovery
+		 * @maxLength 20
+		 */
+		tags: /*#__PURE__*/ v.optional(
+			/*#__PURE__*/ v.constrain(
+				/*#__PURE__*/ v.array(
+					/*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [
+						/*#__PURE__*/ v.stringLength(0, 100),
+						/*#__PURE__*/ v.stringGraphemes(0, 50),
+					]),
+				),
+				[/*#__PURE__*/ v.arrayLength(0, 20)],
+			),
+		),
+		/**
+		 * Document title/headline
+		 * @maxLength 1280
+		 * @maxGraphemes 128
+		 */
+		title: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [
+			/*#__PURE__*/ v.stringLength(0, 1280),
+			/*#__PURE__*/ v.stringGraphemes(0, 128),
+		]),
+		/**
+		 * Timestamp when the document was last modified
+		 */
+		updatedAt: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.datetimeString()),
+	}),
+);
+
+type main$schematype = typeof _mainSchema;
+
+export interface mainSchema extends main$schematype {}
+
+export const mainSchema = _mainSchema as mainSchema;
+
+export interface Main extends v.InferInput<typeof mainSchema> {}
+
+declare module '@atcute/lexicons/ambient' {
+	interface Records {
+		'blog.pckt.document': mainSchema;
+	}
+}

package/lib/lexicons/types/blog/pckt/mark/bold.ts

@@ -0,0 +1,14 @@
+import type {} from '@atcute/lexicons';
+import * as v from '@atcute/lexicons/validations';
+
+const _mainSchema = /*#__PURE__*/ v.object({
+	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('blog.pckt.mark.bold')),
+});
+
+type main$schematype = typeof _mainSchema;
+
+export interface mainSchema extends main$schematype {}
+
+export const mainSchema = _mainSchema as mainSchema;
+
+export interface Main extends v.InferInput<typeof mainSchema> {}

package/lib/lexicons/types/blog/pckt/mark/code.ts

@@ -0,0 +1,14 @@
+import type {} from '@atcute/lexicons';
+import * as v from '@atcute/lexicons/validations';
+
+const _mainSchema = /*#__PURE__*/ v.object({
+	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('blog.pckt.mark.code')),
+});
+
+type main$schematype = typeof _mainSchema;
+
+export interface mainSchema extends main$schematype {}
+
+export const mainSchema = _mainSchema as mainSchema;
+
+export interface Main extends v.InferInput<typeof mainSchema> {}

package/lib/lexicons/types/blog/pckt/mark/italic.ts

@@ -0,0 +1,14 @@
+import type {} from '@atcute/lexicons';
+import * as v from '@atcute/lexicons/validations';
+
+const _mainSchema = /*#__PURE__*/ v.object({
+	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('blog.pckt.mark.italic')),
+});
+
+type main$schematype = typeof _mainSchema;
+
+export interface mainSchema extends main$schematype {}
+
+export const mainSchema = _mainSchema as mainSchema;
+
+export interface Main extends v.InferInput<typeof mainSchema> {}

package/lib/lexicons/types/blog/pckt/mark/link.ts

@@ -0,0 +1,55 @@
+import type {} from '@atcute/lexicons';
+import * as v from '@atcute/lexicons/validations';
+
+const _linkAttrsSchema = /*#__PURE__*/ v.object({
+	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('blog.pckt.mark.link#linkAttrs')),
+	/**
+	 * The URL destination of the hyperlink
+	 * @maxLength 2000
+	 */
+	href: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.genericUriString(), [
+		/*#__PURE__*/ v.stringLength(0, 2000),
+	]),
+	/**
+	 * Defines the relationship between the current document and the linked resource (e.g., nofollow, noopener)
+	 * @maxLength 100
+	 */
+	rel: /*#__PURE__*/ v.optional(
+		/*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [/*#__PURE__*/ v.stringLength(0, 100)]),
+	),
+	/**
+	 * Specifies where to open the linked document (e.g., _blank, _self)
+	 * @maxLength 50
+	 */
+	target: /*#__PURE__*/ v.optional(
+		/*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [/*#__PURE__*/ v.stringLength(0, 50)]),
+	),
+	/**
+	 * Additional information about the link, typically shown as a tooltip on hover
+	 * @maxLength 500
+	 */
+	title: /*#__PURE__*/ v.optional(
+		/*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [/*#__PURE__*/ v.stringLength(0, 500)]),
+	),
+});
+const _mainSchema = /*#__PURE__*/ v.object({
+	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('blog.pckt.mark.link')),
+	/**
+	 * Link attributes that define the hyperlink behavior and destination
+	 */
+	get attrs() {
+		return linkAttrsSchema;
+	},
+});
+
+type linkAttrs$schematype = typeof _linkAttrsSchema;
+type main$schematype = typeof _mainSchema;
+
+export interface linkAttrsSchema extends linkAttrs$schematype {}
+export interface mainSchema extends main$schematype {}
+
+export const linkAttrsSchema = _linkAttrsSchema as linkAttrsSchema;
+export const mainSchema = _mainSchema as mainSchema;
+
+export interface LinkAttrs extends v.InferInput<typeof linkAttrsSchema> {}
+export interface Main extends v.InferInput<typeof mainSchema> {}

package/lib/lexicons/types/blog/pckt/mark/strike.ts

@@ -0,0 +1,14 @@
+import type {} from '@atcute/lexicons';
+import * as v from '@atcute/lexicons/validations';
+
+const _mainSchema = /*#__PURE__*/ v.object({
+	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('blog.pckt.mark.strike')),
+});
+
+type main$schematype = typeof _mainSchema;
+
+export interface mainSchema extends main$schematype {}
+
+export const mainSchema = _mainSchema as mainSchema;
+
+export interface Main extends v.InferInput<typeof mainSchema> {}

package/lib/lexicons/types/blog/pckt/mark/underline.ts

@@ -0,0 +1,14 @@
+import type {} from '@atcute/lexicons';
+import * as v from '@atcute/lexicons/validations';
+
+const _mainSchema = /*#__PURE__*/ v.object({
+	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('blog.pckt.mark.underline')),
+});
+
+type main$schematype = typeof _mainSchema;
+
+export interface mainSchema extends main$schematype {}
+
+export const mainSchema = _mainSchema as mainSchema;
+
+export interface Main extends v.InferInput<typeof mainSchema> {}

package/lib/lexicons/types/blog/pckt/publication.ts

@@ -0,0 +1,101 @@
+import type {} from '@atcute/lexicons';
+import * as v from '@atcute/lexicons/validations';
+import type {} from '@atcute/lexicons/ambient';
+import * as BlogPcktTheme from './theme.js';
+
+const _mainSchema = /*#__PURE__*/ v.record(
+	/*#__PURE__*/ v.tidString(),
+	/*#__PURE__*/ v.object({
+		$type: /*#__PURE__*/ v.literal('blog.pckt.publication'),
+		/**
+		 * Base URL path for the publication (e.g., https://blog.pckt.blog)
+		 * @maxLength 2000
+		 */
+		basePath: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.genericUriString(), [
+			/*#__PURE__*/ v.stringLength(0, 2000),
+		]),
+		/**
+		 * Timestamp when the publication was first created
+		 */
+		createdAt: /*#__PURE__*/ v.datetimeString(),
+		/**
+		 * Publication description or tagline
+		 * @maxLength 2000
+		 * @maxGraphemes 500
+		 */
+		description: /*#__PURE__*/ v.optional(
+			/*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [
+				/*#__PURE__*/ v.stringLength(0, 2000),
+				/*#__PURE__*/ v.stringGraphemes(0, 500),
+			]),
+		),
+		/**
+		 * Extension objects (open union) for additional features
+		 * @maxLength 10
+		 */
+		get extensions() {
+			return /*#__PURE__*/ v.optional(
+				/*#__PURE__*/ v.constrain(/*#__PURE__*/ v.array(/*#__PURE__*/ v.variant([])), [
+					/*#__PURE__*/ v.arrayLength(0, 10),
+				]),
+			);
+		},
+		/**
+		 * Publication icon/avatar image
+		 * @accept image/png, image/jpeg, image/webp, image/gif
+		 * @maxSize 500000
+		 */
+		icon: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.blob()),
+		/**
+		 * Publication name/title
+		 * @maxLength 200
+		 * @maxGraphemes 100
+		 */
+		name: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [
+			/*#__PURE__*/ v.stringLength(0, 200),
+			/*#__PURE__*/ v.stringGraphemes(0, 100),
+		]),
+		/**
+		 * Publication preferences and settings
+		 */
+		get preferences() {
+			return /*#__PURE__*/ v.optional(preferencesSchema);
+		},
+		/**
+		 * Theme configuration as an open union; accepts blog.pckt.theme and future types.
+		 */
+		get theme() {
+			return /*#__PURE__*/ v.optional(/*#__PURE__*/ v.variant([BlogPcktTheme.mainSchema]));
+		},
+		/**
+		 * Timestamp when the publication was last updated (optional)
+		 */
+		updatedAt: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.datetimeString()),
+	}),
+);
+const _preferencesSchema = /*#__PURE__*/ v.object({
+	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('blog.pckt.publication#preferences')),
+	/**
+	 * Whether documents from this publication should appear in public discover feeds
+	 * @default true
+	 */
+	showInDiscover: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.boolean(), true),
+});
+
+type main$schematype = typeof _mainSchema;
+type preferences$schematype = typeof _preferencesSchema;
+
+export interface mainSchema extends main$schematype {}
+export interface preferencesSchema extends preferences$schematype {}
+
+export const mainSchema = _mainSchema as mainSchema;
+export const preferencesSchema = _preferencesSchema as preferencesSchema;
+
+export interface Main extends v.InferInput<typeof mainSchema> {}
+export interface Preferences extends v.InferInput<typeof preferencesSchema> {}
+
+declare module '@atcute/lexicons/ambient' {
+	interface Records {
+		'blog.pckt.publication': mainSchema;
+	}
+}

package/lib/lexicons/types/blog/pckt/theme.ts

@@ -0,0 +1,65 @@
+import type {} from '@atcute/lexicons';
+import * as v from '@atcute/lexicons/validations';
+
+const _mainSchema = /*#__PURE__*/ v.object({
+	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('blog.pckt.theme')),
+	/**
+	 * Dark mode color palette
+	 */
+	get dark() {
+		return paletteSchema;
+	},
+	/**
+	 * Font family name (optional)
+	 * @maxLength 100
+	 */
+	font: /*#__PURE__*/ v.optional(
+		/*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [/*#__PURE__*/ v.stringLength(0, 100)]),
+	),
+	/**
+	 * Light mode color palette
+	 */
+	get light() {
+		return paletteSchema;
+	},
+});
+const _paletteSchema = /*#__PURE__*/ v.object({
+	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('blog.pckt.theme#palette')),
+	/**
+	 * Accent color (hex value)
+	 * @maxLength 7
+	 */
+	accent: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [/*#__PURE__*/ v.stringLength(0, 7)]),
+	/**
+	 * Background color (hex value)
+	 * @maxLength 7
+	 */
+	background: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [/*#__PURE__*/ v.stringLength(0, 7)]),
+	/**
+	 * Link color (hex value)
+	 * @maxLength 7
+	 */
+	link: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [/*#__PURE__*/ v.stringLength(0, 7)]),
+	/**
+	 * Surface hover color (hex value)
+	 * @maxLength 7
+	 */
+	surfaceHover: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [/*#__PURE__*/ v.stringLength(0, 7)]),
+	/**
+	 * Primary text color (hex value)
+	 * @maxLength 7
+	 */
+	text: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [/*#__PURE__*/ v.stringLength(0, 7)]),
+});
+
+type main$schematype = typeof _mainSchema;
+type palette$schematype = typeof _paletteSchema;
+
+export interface mainSchema extends main$schematype {}
+export interface paletteSchema extends palette$schematype {}
+
+export const mainSchema = _mainSchema as mainSchema;
+export const paletteSchema = _paletteSchema as paletteSchema;
+
+export interface Main extends v.InferInput<typeof mainSchema> {}
+export interface Palette extends v.InferInput<typeof paletteSchema> {}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "type": "module",
+  "name": "@atcute/pckt",
+  "version": "0.1.0",
+  "description": "pckt (blog.pckt.*) schema definitions",
+  "keywords": [
+    "atcute",
+    "atproto",
+    "pckt"
+  ],
+  "license": "0BSD",
+  "repository": {
+    "url": "https://github.com/mary-ext/atcute",
+    "directory": "packages/definitions/pckt"
+  },
+  "files": [
+    "dist/",
+    "lib/",
+    "!lib/**/*.bench.ts",
+    "!lib/**/*.test.ts"
+  ],
+  "exports": {
+    ".": "./dist/index.js",
+    "./types/*": "./dist/lexicons/types/blog/pckt/*.js"
+  },
+  "dependencies": {
+    "@atcute/atproto": "^3.1.9",
+    "@atcute/lexicons": "^1.2.5"
+  },
+  "devDependencies": {
+    "@atcute/lex-cli": "^2.5.0"
+  },
+  "atcute:lexicons": {
+    "mappings": {
+      "blog.pckt.*": {
+        "type": "namespace",
+        "path": "./types/{{nsid_remainder}}"
+      }
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "pull": "lex-cli pull",
+    "generate": "rm -r ./lib/lexicons/; lex-cli generate",
+    "prepublish": "rm -rf dist; pnpm run build"
+  }
+}