@sanity/sdk 0.0.2 → 1.0.0

package/README.md

@@ -2,16 +2,18 @@
   <a href="https://sanity.io">
     <img src="https://cdn.sanity.io/images/3do82whm/next/1dfce9dde7a62ccaa8e8377254a1e919f6c07ad3-128x128.svg" />
   </a>
-  <h1 align="center">Sanity Core App SDK</h1>
+  <h1 align="center">Sanity App SDK (Core)</h1>
 </p>
 
-Core functionality powering the React SDK.
+The App SDK Core is a pure TypeScript implementation of the App SDK’s business logic. It powers our React App SDK under the hood, and leaves the door open for future framework specific implementations, too.
 
-## Documentation
+We highly recommend that users default to using the hooks provided by the React SDK for building custom apps on the Sanity platform, unless you’re looking to create your own Sanity App SDK using this core layer.
 
-- Familiarize yourself with the App SDK via a conceptual overview, a quickstart guide, and a step by step walkthrough on **[the Sanity Docs site](https://sanity.io/docs/app-sdk)**
-- Go in depth with the **[App SDK reference docs](https://sdk-docs.sanity.dev)**
-- View example implementations on the **[SDK Explorer](https://sdk-examples.sanity.dev)**
+**Looking for our React SDK?** You’ll find it on:
+
+- [GitHub](https://github.com/sanity-io/sdk/tree/main/packages/react)
+- [Sanity Docs](https://sanity.io/docs/app-sdk)
+- [App SDK (React) reference docs](https://reference.sanity.io/_sanity/sdk-react)
 
 ## License
 

package/dist/index.d.ts

@@ -27,9 +27,9 @@ import {ResponseQueryOptions} from '@sanity/client'
 import {Role} from '@sanity/types'
 import {SanityClient} from '@sanity/client'
 import {SanityDocument} from '@sanity/types'
-import {SanityDocument as SanityDocument_2} from '@sanity/client'
+import {SanityDocument as SanityDocument_2} from 'groq'
+import {SanityDocument as SanityDocument_3} from '@sanity/client'
 import {SanityDocumentLike} from '@sanity/types'
-import {SanityDocumentResult} from 'groq'
 import {SanityProject as SanityProject_2} from '@sanity/client'
 import {SanityProjectionResult} from 'groq'
 import {SanityQueryResult} from 'groq'
@@ -77,9 +77,7 @@ declare type ActionMap = {
 }
 
 /** @beta */
-export declare interface ActionsResult<
-  TDocument extends SanityDocumentResult = SanityDocumentResult,
-> {
+export declare interface ActionsResult<TDocument extends SanityDocument_2 = SanityDocument_2> {
   transactionId: string
   documents: DocumentSet<TDocument>
   previous: DocumentSet<TDocument>
@@ -186,7 +184,7 @@ export declare function applyDocumentActions<
     | DocumentAction<TDocumentType, TDataset, TProjectId>
     | DocumentAction<TDocumentType, TDataset, TProjectId>[],
   options?: ApplyDocumentActionsOptions,
-): Promise<ActionsResult<SanityDocumentResult<TDocumentType, TDataset, TProjectId>>>
+): Promise<ActionsResult<SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`>>>
 
 /** @beta */
 export declare function applyDocumentActions(
@@ -850,12 +848,12 @@ declare interface DocumentState {
    * the "remote" local copy that matches the server. represents the last known
    * server state. this gets updated every time we confirm remote patches
    */
-  remote?: SanityDocument | null
+  remote?: SanityDocument_2 | null
   /**
    * the current ephemeral working copy that includes local optimistic changes
    * that have not yet been confirmed by the server
    */
-  local?: SanityDocument | null
+  local?: SanityDocument_2 | null
   /**
    * the revision that our remote document is at
    */
@@ -891,7 +889,7 @@ declare interface DocumentStoreState {
   grants?: Record<Grant, ExprNode>
   error?: unknown
   sharedListener: SharedListener
-  fetchDocument: (documentId: string) => Observable<SanityDocument | null>
+  fetchDocument: (documentId: string) => Observable<SanityDocument_2 | null>
   events: Subject<DocumentEvent>
 }
 
@@ -1168,7 +1166,7 @@ export declare function getDocumentState<
 >(
   instance: SanityInstance,
   options: DocumentOptions<undefined, TDocumentType, TDataset, TProjectId>,
-): StateSource<SanityDocumentResult<TDocumentType, TDataset, TProjectId> | undefined | null>
+): StateSource<SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`> | undefined | null>
 
 /** @beta */
 export declare function getDocumentState<
@@ -1180,7 +1178,7 @@ export declare function getDocumentState<
   instance: SanityInstance,
   options: DocumentOptions<TPath, TDocumentType, TDataset, TProjectId>,
 ): StateSource<
-  JsonMatch<SanityDocumentResult<TDocumentType, TDataset, TProjectId>, TPath> | undefined
+  JsonMatch<SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`>, TPath> | undefined
 >
 
 /** @beta */
@@ -1308,7 +1306,9 @@ export declare function getProjectionState<
   instance: SanityInstance,
   options: ProjectionOptions<TProjection, TDocumentType, TDataset, TProjectId>,
 ): StateSource<
-  | ProjectionValuePending<SanityProjectionResult<TProjection, TDocumentType, TDataset, TProjectId>>
+  | ProjectionValuePending<
+      SanityProjectionResult<TProjection, TDocumentType, `${TProjectId}.${TDataset}`>
+    >
   | undefined
 >
 
@@ -1368,7 +1368,7 @@ export declare function getQueryState<
 >(
   instance: SanityInstance,
   queryOptions: QueryOptions<TQuery, TDataset, TProjectId>,
-): StateSource<SanityQueryResult<TQuery, TDataset, TProjectId> | undefined>
+): StateSource<SanityQueryResult<TQuery, `${TProjectId}.${TDataset}`> | undefined>
 
 /** @beta */
 export declare function getQueryState<TData>(
@@ -2037,10 +2037,10 @@ export declare function resolveDocument<
 >(
   instance: SanityInstance,
   docHandle: DocumentHandle<TDocumentType, TDataset, TProjectId>,
-): Promise<SanityDocumentResult<TDocumentType, TDataset, TProjectId> | null>
+): Promise<SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`> | null>
 
 /** @beta */
-export declare function resolveDocument<TData extends SanityDocument>(
+export declare function resolveDocument<TData extends SanityDocument_2>(
   instance: SanityInstance,
   docHandle: DocumentHandle<string, string, string>,
 ): Promise<TData | null>
@@ -2096,7 +2096,9 @@ export declare function resolveProjection<
   instance: SanityInstance,
   options: ProjectionOptions<TProjection, TDocumentType, TDataset, TProjectId>,
 ): Promise<
-  ProjectionValuePending<SanityProjectionResult<TProjection, TDocumentType, TDataset, TProjectId>>
+  ProjectionValuePending<
+    SanityProjectionResult<TProjection, TDocumentType, `${TProjectId}.${TDataset}`>
+  >
 >
 
 /** @beta */
@@ -2133,7 +2135,7 @@ export declare function resolveQuery<
 >(
   instance: SanityInstance,
   queryOptions: ResolveQueryOptions<TQuery, TDataset, TProjectId>,
-): Promise<SanityQueryResult<TQuery, TDataset, TProjectId>>
+): Promise<SanityQueryResult<TQuery, `${TProjectId}.${TDataset}`>>
 
 /** @beta */
 export declare function resolveQuery<TData>(
@@ -2350,7 +2352,7 @@ declare interface SelectorNode extends BaseNode {
 }
 
 declare interface SharedListener {
-  events: Observable<ListenEvent<SanityDocument_2>>
+  events: Observable<ListenEvent<SanityDocument_3>>
   dispose: () => void
 }
 

package/dist/index.js

@@ -4824,7 +4824,7 @@ const TITLE_CANDIDATES = ["title", "name", "label", "heading", "header", "captio
   _type,
   _id,
   _updatedAt
-}`, PREVIEW_TAG = "preview", PREVIEW_PERSPECTIVE = "drafts", STABLE_EMPTY_PREVIEW = { data: null, isPending: !1 }, STABLE_ERROR_PREVIEW = {
+}`, PREVIEW_TAG = "preview", PREVIEW_PERSPECTIVE = "raw", STABLE_EMPTY_PREVIEW = { data: null, isPending: !1 }, STABLE_ERROR_PREVIEW = {
   data: {
     title: "Preview Error",
     ...!!getEnv("DEV") && { subtitle: "Check the console for more details" }
@@ -5049,7 +5049,7 @@ function processProjectionQuery({ ids, results }) {
   }
   return finalValues;
 }
-const PROJECTION_TAG = "sdk.projection", PROJECTION_PERSPECTIVE = "drafts", PROJECTION_STATE_CLEAR_DELAY = 1e3, STABLE_EMPTY_PROJECTION = {
+const PROJECTION_TAG = "sdk.projection", PROJECTION_PERSPECTIVE = "raw", PROJECTION_STATE_CLEAR_DELAY = 1e3, STABLE_EMPTY_PROJECTION = {
   data: null,
   isPending: !1
 };
@@ -5405,7 +5405,7 @@ function createGroqSearchFilter(query) {
     `${finalIncrementalToken}${WILDCARD_TOKEN}`
   ), `[@] match text::query("${processedTokens.join(" ").replace(/"/g, '\\"')}")`;
 }
-var version = "0.0.2";
+var version = "1.0.0";
 const CORE_SDK_VERSION = getEnv("PKG_VERSION") || `${version}-development`;
 export {
   AuthStateType,