foldkit 0.9.0-canary.0 → 0.10.0-canary.0

package/README.md

@@ -8,22 +8,26 @@
 
 ## Installation
 
+The best way to get started with Foldkit is to use `create-foldkit-app`. This
+will guide you through creating a new Foldkit project with your preferred
+package manager and example template.
+
 ```bash
-npm install foldkit effect
+npx create-foldkit-app@latest --wizard
 ```
 
 ## Counter Example
 
-```typescript
+```ts
 import { Match as M, Schema } from 'effect'
 import { Runtime } from 'foldkit'
 import { Class, Html, OnClick, button, div } from 'foldkit/html'
-import { ST, ts } from 'foldkit/schema'
+import { ts } from 'foldkit/schema'
 
 // MODEL
 
 const Model = Schema.Number
-type Model = ST<typeof Model>
+type Model = typeof Model.Type
 
 // MESSAGE
 
@@ -33,11 +37,11 @@ const Reset = ts('Reset')
 
 const Message = Schema.Union(Decrement, Increment, Reset)
 
-type Decrement = ST<typeof Decrement>
-type Increment = ST<typeof Increment>
-type Reset = ST<typeof Reset>
+type Decrement = typeof Decrement.Type
+type Increment = typeof Increment.Type
+type Reset = typeof Reset.Type
 
-type Message = ST<typeof Message>
+type Message = typeof Message.Type
 
 // UPDATE
 

package/dist/runtime/addNavigationEventListeners.js

@@ -8,17 +8,7 @@ export const addNavigationEventListeners = (messageQueue, browserConfig) => {
 };
 const addPopStateListener = (messageQueue, browserConfig) => {
     const onPopState = () => {
-        const search = StringExt.stripPrefixNonEmpty('?')(window.location.search);
-        const hash = StringExt.stripPrefixNonEmpty('#')(window.location.hash);
-        const newUrl = {
-            protocol: window.location.protocol,
-            host: window.location.host,
-            port: OptionExt.fromString(window.location.port),
-            pathname: window.location.pathname,
-            search,
-            hash,
-        };
-        Queue.unsafeOffer(messageQueue, browserConfig.onUrlChange(newUrl));
+        Queue.unsafeOffer(messageQueue, browserConfig.onUrlChange(locationToUrl()));
     };
     window.addEventListener('popstate', onPopState);
 };
@@ -44,33 +34,25 @@ const addLinkClickListener = (messageQueue, browserConfig) => {
             Queue.unsafeOffer(messageQueue, browserConfig.onUrlRequest(External.make({ href })));
             return;
         }
-        const { protocol, host, port, pathname, search, hash } = linkUrl;
-        const url = {
-            protocol,
-            host,
-            port: OptionExt.fromString(port),
-            pathname,
-            search: StringExt.stripPrefixNonEmpty('?')(search),
-            hash: StringExt.stripPrefixNonEmpty('#')(hash),
-        };
-        Queue.unsafeOffer(messageQueue, browserConfig.onUrlRequest(Internal.make({ url })));
+        Queue.unsafeOffer(messageQueue, browserConfig.onUrlRequest(Internal.make({ url: urlToFoldkitUrl(linkUrl) })));
     };
     document.addEventListener('click', onLinkClick);
 };
 const addProgrammaticNavigationListener = (messageQueue, browserConfig) => {
     const onProgrammaticNavigation = () => {
-        const search = StringExt.stripPrefixNonEmpty('?')(window.location.search);
-        const hash = StringExt.stripPrefixNonEmpty('#')(window.location.hash);
-        const { location: { protocol, host, port, pathname }, } = window;
-        const newUrl = {
-            protocol,
-            host,
-            port: OptionExt.fromString(port),
-            pathname,
-            search,
-            hash,
-        };
-        Queue.unsafeOffer(messageQueue, browserConfig.onUrlChange(newUrl));
+        Queue.unsafeOffer(messageQueue, browserConfig.onUrlChange(locationToUrl()));
     };
     window.addEventListener('foldkit:urlchange', onProgrammaticNavigation);
 };
+const urlToFoldkitUrl = (url) => {
+    const { protocol, hostname, port, pathname, search, hash } = url;
+    return {
+        protocol,
+        host: hostname,
+        port: OptionExt.fromString(port),
+        pathname,
+        search: StringExt.stripPrefixNonEmpty('?')(search),
+        hash: StringExt.stripPrefixNonEmpty('#')(hash),
+    };
+};
+const locationToUrl = () => urlToFoldkitUrl(new URL(window.location.href));

package/dist/runtime/urlRequest.d.ts

@@ -9,11 +9,11 @@ export declare const Internal: S.TaggedStruct<"Internal", {
         hash: S.OptionFromSelf<typeof S.String>;
     }>;
 }>;
-export type Internal = S.Schema.Type<typeof Internal>;
+export type Internal = typeof Internal.Type;
 export declare const External: S.TaggedStruct<"External", {
     href: typeof S.String;
 }>;
-export type External = S.Schema.Type<typeof External>;
+export type External = typeof External.Type;
 export declare const UrlRequest: S.Union<[S.TaggedStruct<"Internal", {
     url: S.Struct<{
         protocol: typeof S.String;
@@ -26,5 +26,5 @@ export declare const UrlRequest: S.Union<[S.TaggedStruct<"Internal", {
 }>, S.TaggedStruct<"External", {
     href: typeof S.String;
 }>]>;
-export type UrlRequest = S.Schema.Type<typeof UrlRequest>;
+export type UrlRequest = typeof UrlRequest.Type;
 //# sourceMappingURL=urlRequest.d.ts.map

package/dist/runtime/urlRequest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"urlRequest.d.ts","sourceRoot":"","sources":["../../src/runtime/urlRequest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC,EAAE,MAAM,QAAQ,CAAA;AAIpC,eAAO,MAAM,QAAQ;;;;;;;;;EAEnB,CAAA;AACF,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,QAAQ,CAAC,CAAA;AAErD,eAAO,MAAM,QAAQ;;EAEnB,CAAA;AACF,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,QAAQ,CAAC,CAAA;AAErD,eAAO,MAAM,UAAU;;;;;;;;;;;IAA8B,CAAA;AACrD,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,UAAU,CAAC,CAAA"}
+{"version":3,"file":"urlRequest.d.ts","sourceRoot":"","sources":["../../src/runtime/urlRequest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC,EAAE,MAAM,QAAQ,CAAA;AAIpC,eAAO,MAAM,QAAQ;;;;;;;;;EAEnB,CAAA;AACF,MAAM,MAAM,QAAQ,GAAG,OAAO,QAAQ,CAAC,IAAI,CAAA;AAE3C,eAAO,MAAM,QAAQ;;EAEnB,CAAA;AACF,MAAM,MAAM,QAAQ,GAAG,OAAO,QAAQ,CAAC,IAAI,CAAA;AAE3C,eAAO,MAAM,UAAU;;;;;;;;;;;IAA8B,CAAA;AACrD,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,IAAI,CAAA"}

package/dist/schema.d.ts

@@ -17,21 +17,4 @@ export declare const ts: {
     <Tag extends string>(tag: Tag): S.TaggedStruct<Tag, {}>;
     <Tag extends string, Fields extends S.Struct.Fields>(tag: Tag, fields: Fields): S.TaggedStruct<Tag, Fields>;
 };
-/**
- * Extracts the TypeScript type from an Effect Schema.
- *
- * Abbreviated as `ST` (Schema Type) because it's used frequently throughout Foldkit applications.
- *
- * @example
- * ```typescript
- * const Model = S.Struct({ count: S.Number })
- * type Model = ST<typeof Model> // { count: number }
- *
- * const Reset = ts('Reset')
- * type Reset = ST<typeof Reset> // { _tag: "Reset" }
- * ```
- *
- * @template T - The Schema to extract the type from
- */
-export type ST<T> = S.Schema.Type<T>;
 //# sourceMappingURL=schema.d.ts.map

package/dist/schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC,EAAE,MAAM,QAAQ,CAAA;AAEpC;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,EAAE,EAAE;IACf,CAAC,GAAG,SAAS,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC,YAAY,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;IACvD,CAAC,GAAG,SAAS,MAAM,EAAE,MAAM,SAAS,CAAC,CAAC,MAAM,CAAC,MAAM,EACjD,GAAG,EAAE,GAAG,EACR,MAAM,EAAE,MAAM,GACb,CAAC,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;CAEG,CAAA;AAEnC;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC,EAAE,MAAM,QAAQ,CAAA;AAEpC;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,EAAE,EAAE;IACf,CAAC,GAAG,SAAS,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC,YAAY,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;IACvD,CAAC,GAAG,SAAS,MAAM,EAAE,MAAM,SAAS,CAAC,CAAC,MAAM,CAAC,MAAM,EACjD,GAAG,EAAE,GAAG,EACR,MAAM,EAAE,MAAM,GACb,CAAC,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;CAEG,CAAA"}

package/dist/url.d.ts

@@ -7,7 +7,7 @@ export declare const Url: S.Struct<{
     search: S.OptionFromSelf<typeof S.String>;
     hash: S.OptionFromSelf<typeof S.String>;
 }>;
-export type Url = S.Schema.Type<typeof Url>;
+export type Url = typeof Url.Type;
 export declare const fromString: (str: string) => Option.Option<{
     readonly search: Option.Option<string>;
     readonly protocol: string;

package/dist/url.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../src/url.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,MAAM,EAAe,MAAM,IAAI,CAAC,EAAU,MAAM,QAAQ,CAAA;AAIzE,eAAO,MAAM,GAAG;;;;;;;EAOd,CAAA;AACF,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,CAAA;AAyE3C,eAAO,MAAM,UAAU,GAAI,KAAK,MAAM;;;;;;;EAAuC,CAAA;AAC7E,eAAO,MAAM,QAAQ,GAAI,KAAK,GAAG,WAAqC,CAAA"}
+{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../src/url.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,MAAM,EAAe,MAAM,IAAI,CAAC,EAAU,MAAM,QAAQ,CAAA;AAIzE,eAAO,MAAM,GAAG;;;;;;;EAOd,CAAA;AACF,MAAM,MAAM,GAAG,GAAG,OAAO,GAAG,CAAC,IAAI,CAAA;AAyEjC,eAAO,MAAM,UAAU,GAAI,KAAK,MAAM;;;;;;;EAAuC,CAAA;AAC7E,eAAO,MAAM,QAAQ,GAAI,KAAK,GAAG,WAAqC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "foldkit",
-  "version": "0.9.0-canary.0",
+  "version": "0.10.0-canary.0",
   "description": "Elm-inspired UI framework powered by Effect",
   "type": "module",
   "main": "./dist/index.js",