graze-client 0.3.3 → 0.3.4

package/README.md

@@ -6,7 +6,21 @@ This is a simple Typescript package for interacting with the [Graze](https://gra
 npm install graze-client
 ```
 
-It is a bit hastily put together and under development (not all APIs are implemented), but it works. Currently it is only deployed as ESM with Typescript declarations.
+## Features
+
+1. **getFeeds:** Get all your graze feeds.
+1. **getFeed:** Get a specific feed.
+1. **hidePost:** Hide a post from a feed.
+1. **updateAlgorithm:** Update an algorithm.
+1. **publishAlgorithm:** Publish an algorithm.
+1. **Algorithm Builder:** A custom utility to make building an algorithm easier. See the example below.
+
+### This is a WIP
+
+This package is under development, so if you find bugs, please report. Known issues include:
+
+1. Not all graze operators or APIs are implemented. I have only implemented what I need so far, so feed free to make a PR adding more.
+2. Not everything is documented, but typescript is your friend. It you use this in an editor like VSCode, you should get good autocomplete hints for types.
 
 ## Usage
 
@@ -17,38 +31,67 @@ There are two exports:
 ### 1. A promise-based `GrazeService`
 
 ```ts
-import { GrazeService } from "graze-client";
+import { GrazeService, F, Algo, FullForm } from "graze-client";
 
 const graze = new GrazeService({
   apiUrl: "https://api.graze.social",
-  cookie: "my-graze-cookie",
+  cookie: "<change this>",
   userId: 15,
 });
 
+// get feets
 const myFeeds = await graze.getFeeds();
 const feed = await graze.getFeed({ path: { feedId: 1234 } });
 // hide a post
 await graze.hidePost({
   payload: { algo_id: 1234, at_uri: "at://<did>/app.bsky.feed.post/<rkey>" },
 });
-// update an algorithm
-const hasVideo: Form.Filter = {
-  embed_type: ["==", "video"],
-};
-const hasKeyword: Form.Filter = {
-  regex_matches: ["text", /Hello World!/.source, true],
-};
-const res = await graze.updateAlgorithm({
-  record_name: "my-feed",
-  display_name: "My Feed",
+
+// build a complex algorithm
+
+const hasNoBadContent = F.and(
+  F.isContentOk(0.9),
+  F.hasNoNSFWLabels,
+  F.isNotListMember("my-blocklist-url")
+);
+
+const algo = Algo.filter(
+  // the top level filter will combine elements in an "and" block
+  hasNoBadContent,
+  F.hasVideo,
+  F.or(
+    F.posterFollows("@samuel.bsky.team"),
+    F.isListMember("my-whitelist-url"),
+    F.and(
+      F.regexMatches("text", "my-keyword-regex"),
+      F.regexMatches("embed.alt", "my-keyword-regex"),
+      F.regexMatches("embed.external.title", "my-keyword-regex"),
+      F.regexMatches("embed.external.description", "my-keyword-regex"),
+      F.isPost
+    ),
+    F.or(
+      // nested logic blocks will be automatically flattened, so this will
+      // be brought up one level since it is logically equivalent.
+      F.regexNegationMatches("text", "my-negative-keyword-regex")
+    )
+  )
+);
+
+const manifest: FullForm = {
+  algorithm_manifest: algo,
+  id: 12,
   user_id: 1,
+  display_name: "My Fancy Feed",
+  // file:  add a file blob here to update the image
+  description: "This is a fancy feed with lots of logic for fun and profit.",
   order: "new",
-  id: 1234,
-  algorithm_manifest: {
-    filter: { and: [hasVideo, hasKeyword] },
-  },
-});
+  // CAUTION: this will change the feed slug and cause you to lose existing follows.
+  // but if you do it, don't worry you can set it back and it will be fixed : ).
+  record_name: "my-fancy-feed",
+};
 
+// send the algorithm to graze
+const response = await graze.updateAlgorithm(manifest);
 // publish the algorithm
 const res = await graze.publishAlgorithm({ path: { feedId: 1234 } });
 ```

package/build/dts/index.d.ts

@@ -13,5 +13,6 @@ export declare class GrazeService {
         userId: number;
     });
 }
-export {};
+export * from "./schema/index.js";
+export { F, Algo } from "./builder.js";
 //# sourceMappingURL=index.d.ts.map

package/build/dts/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,MAAM,EAAS,MAAM,QAAQ,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,KAAK,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,CAC5B,GAAG,IAAI,EAAE,GAAG,EAAE,KACX,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,EAAE,KAAK,CAAC,GACvC,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,GACtC,KAAK,CAAC;AAEV,qBAAa,YAAY;IACvB,OAAO,EAAE,SAAS,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACvD,QAAQ,EAAE,SAAS,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACzD,QAAQ,EAAE,SAAS,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACzD,eAAe,EAAE,SAAS,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IACvE,gBAAgB,EAAE,SAAS,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;gBAE7D,EACV,MAAM,EACN,MAAM,EACN,MAAM,GACP,EAAE;QACD,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;KAChB;CAmBF"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,MAAM,EAAS,MAAM,QAAQ,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,KAAK,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,CAC5B,GAAG,IAAI,EAAE,GAAG,EAAE,KACX,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,EAAE,KAAK,CAAC,GACvC,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,GACtC,KAAK,CAAC;AAEV,qBAAa,YAAY;IACvB,OAAO,EAAE,SAAS,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACvD,QAAQ,EAAE,SAAS,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACzD,QAAQ,EAAE,SAAS,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACzD,eAAe,EAAE,SAAS,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IACvE,gBAAgB,EAAE,SAAS,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;gBAE7D,EACV,MAAM,EACN,MAAM,EACN,MAAM,GACP,EAAE;QACD,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;KAChB;CAmBF;AA0BD,cAAc,mBAAmB,CAAC;AAClC,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC"}

package/build/esm/index.js

@@ -38,4 +38,6 @@ const setup = Effect.gen(function* () {
         publishAlgorithm,
     };
 });
+export * from "./schema/index.js";
+export { F, Algo } from "./builder.js";
 //# sourceMappingURL=index.js.map

package/build/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAQ/C,MAAM,OAAO,YAAY;IACvB,OAAO,CAAgD;IACvD,QAAQ,CAAiD;IACzD,QAAQ,CAAiD;IACzD,eAAe,CAAwD;IACvE,gBAAgB,CAAyD;IAEzE,YAAY,EACV,MAAM,EACN,MAAM,EACN,MAAM,GAKP;QACC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC;YACrB,CAAC,eAAe,EAAE,MAAM,CAAC;YACzB,CAAC,cAAc,EAAE,MAAM,CAAC;YACxB,CAAC,eAAe,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC;SACrC,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAChD,MAAM,KAAK,GAAG,KAAK,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAChD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CACrB,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,EACnC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CACtB,CAAC;QACF,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;QAC7B,IAAI,CAAC,eAAe,GAAG,GAAG,CAAC,eAAe,CAAC;QAC3C,IAAI,CAAC,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;IAC/C,CAAC;CACF;AAED,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAChC,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,WAAW,CAAC;IAClC,MAAM,OAAO,GAAG,CAAC,GAAG,IAAuC,EAAE,EAAE,CAC7D,MAAM,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAClD,MAAM,QAAQ,GAAG,CAAC,GAAG,IAAwC,EAAE,EAAE,CAC/D,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACnD,MAAM,QAAQ,GAAG,CAAC,GAAG,IAAwC,EAAE,EAAE,CAC/D,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACnD,MAAM,eAAe,GAAG,CACtB,GAAG,IAA+C,EAClD,EAAE,CAAC,MAAM,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAC7D,MAAM,gBAAgB,GAAG,CACvB,GAAG,IAAgD,EACnD,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAE9D,OAAO;QACL,OAAO;QACP,QAAQ;QACR,QAAQ;QACR,eAAe;QACf,gBAAgB;KACjB,CAAC;AACJ,CAAC,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAQ/C,MAAM,OAAO,YAAY;IACvB,OAAO,CAAgD;IACvD,QAAQ,CAAiD;IACzD,QAAQ,CAAiD;IACzD,eAAe,CAAwD;IACvE,gBAAgB,CAAyD;IAEzE,YAAY,EACV,MAAM,EACN,MAAM,EACN,MAAM,GAKP;QACC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC;YACrB,CAAC,eAAe,EAAE,MAAM,CAAC;YACzB,CAAC,cAAc,EAAE,MAAM,CAAC;YACxB,CAAC,eAAe,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC;SACrC,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAChD,MAAM,KAAK,GAAG,KAAK,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAChD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CACrB,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,EACnC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CACtB,CAAC;QACF,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;QAC7B,IAAI,CAAC,eAAe,GAAG,GAAG,CAAC,eAAe,CAAC;QAC3C,IAAI,CAAC,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;IAC/C,CAAC;CACF;AAED,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAChC,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,WAAW,CAAC;IAClC,MAAM,OAAO,GAAG,CAAC,GAAG,IAAuC,EAAE,EAAE,CAC7D,MAAM,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAClD,MAAM,QAAQ,GAAG,CAAC,GAAG,IAAwC,EAAE,EAAE,CAC/D,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACnD,MAAM,QAAQ,GAAG,CAAC,GAAG,IAAwC,EAAE,EAAE,CAC/D,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACnD,MAAM,eAAe,GAAG,CACtB,GAAG,IAA+C,EAClD,EAAE,CAAC,MAAM,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAC7D,MAAM,gBAAgB,GAAG,CACvB,GAAG,IAAgD,EACnD,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAE9D,OAAO;QACL,OAAO;QACP,QAAQ;QACR,QAAQ;QACR,eAAe;QACf,gBAAgB;KACjB,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,cAAc,mBAAmB,CAAC;AAClC,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graze-client",
-  "version": "0.3.3",
+  "version": "0.3.4",
   "type": "module",
   "license": "MIT",
   "description": "A Typescript Graze API client.",

package/src/index.ts

@@ -66,3 +66,6 @@ const setup = Effect.gen(function* () {
     publishAlgorithm,
   };
 });
+
+export * from "./schema/index.js";
+export { F, Algo } from "./builder.js";