@atcute/whitewind 1.0.0

package/LICENSE

@@ -0,0 +1,17 @@
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,9 @@
+# @atcute/whitewind
+
+[WhiteWind](https://whtwnd.com) type definitions for `@atcute/client`, a lightweight and cute API client for AT Protocol.
+
+import the lexicons module to start using it.
+
+```ts
+import '@atcute/whitewind/lexicons';
+```

package/dist/lexicons.d.ts

@@ -0,0 +1,130 @@
+/**
+ * @module
+ * Contains type declarations for WhiteWind lexicons
+ */
+import '@atcute/client/lexicons';
+declare module '@atcute/client/lexicons' {
+    namespace ComWhtwndBlogComment {
+        interface Record {
+            /** Maximum string length: 1000 */
+            content: string;
+            entryUri: At.Uri;
+        }
+    }
+    namespace ComWhtwndBlogDefs {
+        interface BlobMetadata {
+            [Brand.Type]?: 'com.whtwnd.blog.defs#blobMetadata';
+            blobref: At.Blob;
+            name?: string;
+        }
+        interface BlogEntry {
+            [Brand.Type]?: 'com.whtwnd.blog.defs#blogEntry';
+            /** Maximum string length: 100000 */
+            content: string;
+            createdAt?: string;
+        }
+        interface Comment {
+            [Brand.Type]?: 'com.whtwnd.blog.defs#comment';
+            /** Maximum string length: 1000 */
+            content: string;
+            entryUri: At.Uri;
+        }
+        interface Ogp {
+            [Brand.Type]?: 'com.whtwnd.blog.defs#ogp';
+            url: string;
+            height?: number;
+            width?: number;
+        }
+    }
+    namespace ComWhtwndBlogEntry {
+        interface Record {
+            /** Maximum string length: 100000 */
+            content: string;
+            blobs?: ComWhtwndBlogDefs.BlobMetadata[];
+            createdAt?: string;
+            /** (DEPRECATED) Marks this entry as draft to tell AppViews not to show it to anyone except for the author */
+            isDraft?: boolean;
+            ogp?: ComWhtwndBlogDefs.Ogp;
+            theme?: 'github-light';
+            /** Maximum string length: 1000 */
+            title?: string;
+            /**
+             * Tells the visibility of the article to AppView.
+             * @default "public"
+             */
+            visibility?: 'public' | 'url' | 'author';
+        }
+    }
+    /** Get blog posts associated to designated author. */
+    namespace ComWhtwndBlogGetAuthorPosts {
+        interface Params {
+            author: At.DID;
+        }
+        type Input = undefined;
+        interface Output {
+            post: ComWhtwndBlogDefs.BlogEntry[];
+        }
+    }
+    /** Get AT URI by blog author and entry name. If there are multiple blog entries associated with the name, return the latest one. */
+    namespace ComWhtwndBlogGetEntryMetadataByName {
+        interface Params {
+            author: string;
+            entryTitle: string;
+        }
+        type Input = undefined;
+        interface Output {
+            entryUri: At.Uri;
+            cid?: At.CID;
+            lastUpdate?: string;
+        }
+        interface Errors {
+            NotFound: {};
+        }
+    }
+    /** Get comments associated to designated post. */
+    namespace ComWhtwndBlogGetMentionsByEntry {
+        interface Params {
+            postUri: At.Uri;
+        }
+        type Input = undefined;
+        interface Output {
+            mentions: At.Uri[];
+        }
+    }
+    /** Notify AppView of existence of new entry and request indexing */
+    namespace ComWhtwndBlogNotifyOfNewEntry {
+        interface Params {
+        }
+        interface Input {
+            entryUri: At.Uri;
+        }
+        interface Output {
+        }
+        interface Errors {
+        }
+    }
+    interface Records {
+        'com.whtwnd.blog.comment': ComWhtwndBlogComment.Record;
+        'com.whtwnd.blog.entry': ComWhtwndBlogEntry.Record;
+    }
+    interface Queries {
+        'com.whtwnd.blog.getAuthorPosts': {
+            params: ComWhtwndBlogGetAuthorPosts.Params;
+            output: ComWhtwndBlogGetAuthorPosts.Output;
+        };
+        'com.whtwnd.blog.getEntryMetadataByName': {
+            params: ComWhtwndBlogGetEntryMetadataByName.Params;
+            output: ComWhtwndBlogGetEntryMetadataByName.Output;
+        };
+        'com.whtwnd.blog.getMentionsByEntry': {
+            params: ComWhtwndBlogGetMentionsByEntry.Params;
+            output: ComWhtwndBlogGetMentionsByEntry.Output;
+        };
+    }
+    interface Procedures {
+        'com.whtwnd.blog.notifyOfNewEntry': {
+            input: ComWhtwndBlogNotifyOfNewEntry.Input;
+            output: ComWhtwndBlogNotifyOfNewEntry.Output;
+        };
+    }
+}

package/dist/lexicons.js

@@ -0,0 +1,8 @@
+/* eslint-disable */
+// This file is automatically generated, do not edit!
+/**
+ * @module
+ * Contains type declarations for WhiteWind lexicons
+ */
+import '@atcute/client/lexicons';
+//# sourceMappingURL=lexicons.js.map

package/dist/lexicons.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lexicons.js","sourceRoot":"","sources":["../lib/lexicons.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,qDAAqD;AAErD;;;GAGG;AAEH,OAAO,yBAAyB,CAAC"}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "type": "module",
+  "name": "@atcute/whitewind",
+  "version": "1.0.0",
+  "description": "WhiteWind type definitions for atcute",
+  "license": "MIT",
+  "repository": {
+    "url": "https://codeberg.org/mary-ext/atcute"
+  },
+  "files": [
+    "dist/"
+  ],
+  "exports": {
+    "./lexicons": "./dist/lexicons.js"
+  },
+  "peerDependencies": {
+    "@atcute/client": "^1.0.0"
+  },
+  "devDependencies": {
+    "@atcute/client": "^1.0.0",
+    "@atcute/lex-cli": "^1.0.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "generate": "./scripts/generate-lexicons.sh",
+    "prepublish": "rm -rf dist; pnpm run build"
+  }
+}