TS Safe Assignment, Sanity CMS Basic Library & Splitting Utils Package #57

Aerilym · 2024-09-30T06:31:04Z

Summary

Split the utility package into tighter scoped packages, created a generic Sanity CMS library, and implemented basic version of the TypeScript safe assignment operator proposal to investigate its usefulness and hopefully enhance state management stability for decentralized apps.

Key Updates

Utility Package Refactoring:
- Split the @session/util package into modular packages for JavaScript utilities, crypto functions, and logging to improve separation of concerns.
Sanity CMS Integration:
- Created a generalized Sanity CMS package and a dedicated types package for schema-based type safety.
- Implemented basic Sanity schemas, queries, and preview components.
- Added configuration files, singleton schemas, SEO types, and enhanced error reporting.
API Enhancements:
- Created API endpoint creators to support draft mode, improving content management workflows.
Error Handling & Safe Assignment Operator Proposal:
- Added a custom error test expectation and introduced a safeTry function for safer error handling and reduced risk of unhandled exceptions.
- Implemented a basic version of the Sage 0 safe assignment operator proposal to address state management and integrity issues in decentralized applications.
- Links to proposal:
  - Proposal Overview
  - More Info
Miscellaneous Improvements:
- Fixed various linting errors, removed unused code, and updated environment logging and import.

…ypto and @session/util-logger

yougotwill

Great work man! Couple of comments

yougotwill · 2024-10-01T04:45:09Z

packages/util-js/try.ts

+ * return result;
+ * ```
+ */
+export async function safeTry<T, E = Error>(promise: Promise<T>): Promise<[null, T] | [E, null]> {


Nice code although it is interested this needed to become a tool but I guess you thought you would use it a lot more in future.

I decided to give it a go, would be incredible for the general state management and integrity problem with decentralized apps, plus I think it has a lot of potential for general js stability improvements. It's a basic implementation of the sage 0 safe assignment operator
TypeScript proposal:

https://github.com/arthurfiorette/proposal-safe-assignment-operator

https://arthur.run/proposal-safe-assignment-operator/

yougotwill · 2024-10-01T04:47:01Z

packages/util-js/tests/try.spec.ts

+  it('should return a tuple with an error if the promise rejects', async () => {
+    expect.assertions(5);
+
+    const result = await safeTry(Promise.reject(new Error('foo')));


This is nitpicking but you could just create the error once right? const fooError = new Error('foo');

yougotwill · 2024-10-01T05:04:10Z

packages/util-js/env.ts

+ */
+export const setEnvironment = (environment: Environment) => {
+  if (!isEnvironment(environment)) {
+    console.warn(`Invalid environment: ${environment}`);


Not console.error?

Just a warning, have updated to say it defaults to dev now

yougotwill · 2024-10-01T05:05:25Z

packages/util-js/env.ts

+
+/**
+ * Retrieves the current environment based on the value of {@link env}. If the environment is not
+ * set, it defaults to fetches it from the NEXT_PUBLIC_ENV_FLAG environment variable.


Are we planning to use util-js in session-desktop? If so might be best to not have the NEXT flag hardcoded. Maybe you can pass it through?

Yeah will have to work out a better solution, the only env variables client-side next can see are ones prefixed with NEXT_PUBLIC_. When we use this on desktop we can decide on what to use cross-environment.

yougotwill · 2024-10-01T05:06:36Z

packages/util-js/README.md


-This package is a utility library for common functions.
+This package is a js utility library for common functions.


Is this not technically ts? 😂

I mean it's written in ts but all the functionality is transpiled to js so it is a js utility library. imo something is only a ts library if its explicitly for ts, not js. eg: sanity-types vs sent-staking-js

yougotwill · 2024-10-01T06:50:38Z

packages/sanity-cms/lib/preview.ts

+import type { RouteSchemaType } from '../schemas/fields/groups/route';
+
+// Customise this function to show the correct URL based on the current document
+function getPreviewUrl(route: RouteSchemaType) {


This is not used. Did you mean to export it?

Also should we check if window exists first?

yougotwill · 2024-10-01T06:54:27Z

packages/sanity-cms/lib/fetch.ts

+ * relying on global type declarations and this caused a global type conflicts, forcing the `next`
+ * and `cache` properties to be ONLY `undefined` as TS couldn't find the `next property in all
+ * @see {RequestInit} declarations (it's only in the next.js declaration, not node, web lib, or
+ * workers versions).


You mad?😂

hahaha i may have been a little fed up at that point. but im not wrong. :)

yougotwill · 2024-10-01T06:59:21Z

packages/sanity-cms/lib/config.ts

+  projectId: string;
+  dataset: string;
+  /** Must match the route of your Studio */
+  studioBasePath: string;


Suggested change

studioBasePath: string;

/** Must match the route of your Sanity Studio instance */

yougotwill · 2024-10-01T07:10:27Z

packages/sanity-cms/components/SanityStudioSSRPage.tsx

@@ -0,0 +1,13 @@
+import { type ReactNode, Suspense } from 'react';
+
+export const dynamic = 'force-static';


What does this do? Can you docstring it please?🙏

yougotwill · 2024-10-01T07:24:26Z

packages/sanity-cms/api/revalidate.ts

+
+      // If the `_type` is `post`, then all `client.fetch` calls with
+      // `{next: {tags: ['post']}}` will be revalidated
+      revalidateTag(body._type);


Yeah once I'm back you are going to have to teach me this stuff. Impressive but also a bit beyond my current knowledge

haha sounds good, theres a lot of next magic going on

…eration

…d layouts

Aerilym added 5 commits September 30, 2024 16:26

chore: split @session/util into @session/util-js and @session/util-cr…

619099d

…ypto and @session/util-logger

feat: create custom getError test expectation

29d6db6

feat: create safeTry function

db85b72

fix: staked cards showing soon instead of now

bd99144

feat: create @session/sanity-cms package

bae61ba

Aerilym requested a review from yougotwill September 30, 2024 06:31

Aerilym changed the title ~~Sanity cms~~ Sanity CMS & Splitting Utils Package Sep 30, 2024

Aerilym added enhancement New feature or request monorepo Changes to general monorepo labels Sep 30, 2024

fix: add util packages as transpiled for staking portal

fcacfbf

Aerilym changed the title ~~Sanity CMS & Splitting Utils Package~~ Sanity CMS Basic Library & Splitting Utils Package Sep 30, 2024

Aerilym added 7 commits October 1, 2024 14:08

feat: create api endpoint creators for draft mode

76ae5f4

feat: create sanity config file

2a8e959

fix: sanity custom fetcher overriding default fetcher

a158822

feat: preview components

886bb56

feat: basic sanity schemas and queries

44a0f4d

feat: create sanity-types package

7031ec1

chore: fix type errors

f7905a9

yougotwill requested changes Oct 1, 2024

View reviewed changes

Aerilym added 9 commits October 2, 2024 09:12

feat: add singleton schemas and error reporting for sanity config gen…

df6533c

…eration

chore: update default env warning log

677bc62

chore: move test error creation to constant

6580e65

chore: fix linting type errors on sanity-types package

c78f340

chore: removed unused function

dd3d0fc

chore: fix sanity preview imports

ccea36e

chore: add comment about next.js 'dynamic' exported const on pages an…

f380deb

…d layouts

feat: add SEO sanity type

4b62a15

feat: add SEO sanity type to custom types

195fbab

Aerilym requested a review from yougotwill October 1, 2024 23:51

fix: remove unsafe optional chaining of schema filter

8cac3e1

feat: add sanity-icons and preflight plugins

f7ec4e1

Aerilym changed the title ~~Sanity CMS Basic Library & Splitting Utils Package~~ TS Safe Assignment, Sanity CMS Basic Library & Splitting Utils Package Oct 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TS Safe Assignment, Sanity CMS Basic Library & Splitting Utils Package #57

TS Safe Assignment, Sanity CMS Basic Library & Splitting Utils Package #57

Aerilym commented Sep 30, 2024 •

edited

Loading

yougotwill left a comment

yougotwill Oct 1, 2024

Aerilym Oct 1, 2024

yougotwill Oct 1, 2024

yougotwill Oct 1, 2024

Aerilym Oct 1, 2024

yougotwill Oct 1, 2024

Aerilym Oct 1, 2024

yougotwill Oct 1, 2024

Aerilym Oct 1, 2024

yougotwill Oct 1, 2024

yougotwill Oct 1, 2024

Aerilym Oct 1, 2024

yougotwill Oct 1, 2024

Aerilym Oct 1, 2024

yougotwill Oct 1, 2024

yougotwill Oct 1, 2024

Aerilym Oct 1, 2024

yougotwill Oct 1, 2024

Aerilym Oct 1, 2024


		This package is a utility library for common functions.
		This package is a js utility library for common functions.

	studioBasePath: string;
	/** Must match the route of your Sanity Studio instance */

		@@ -0,0 +1,13 @@
		import { type ReactNode, Suspense } from 'react';

		export const dynamic = 'force-static';

TS Safe Assignment, Sanity CMS Basic Library & Splitting Utils Package #57

Are you sure you want to change the base?

TS Safe Assignment, Sanity CMS Basic Library & Splitting Utils Package #57

Conversation

Aerilym commented Sep 30, 2024 • edited Loading

Summary

Key Updates

yougotwill left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Aerilym commented Sep 30, 2024 •

edited

Loading