pinejs-client-core 8.1.5 → 8.1.6-build-strict-mode-ef861ef2e796bdb61ba57eaa765a41316e59bbbf-1

package/.versionbot/CHANGELOG.yml

@@ -1,3 +1,15 @@
+- commits:
+    - subject: WIP Add strict pinejs mode
+      hash: ef861ef2e796bdb61ba57eaa765a41316e59bbbf
+      body: ""
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: Otavio Jacobi
+      nested: []
+  version: 8.1.6
+  title: ""
+  date: 2025-05-29T00:57:24.688Z
 - commits:
     - subject: Fix linting
       hash: 29627add4a7c5701c9e4f032ea1f15a0523e2877
@@ -9,7 +21,7 @@
       nested: []
   version: 8.1.5
   title: ""
-  date: 2025-05-23T00:11:18.340Z
+  date: 2025-05-23T11:24:08.969Z
 - commits:
     - subject: Update dependency mocha to v11
       hash: 85c2c2a779ba2cc94da6d35504e4f5ffb0263dcc

package/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file
 automatically by Versionist. DO NOT EDIT THIS FILE MANUALLY!
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 8.1.6 - 2025-05-29
+
+* WIP Add strict pinejs mode [Otavio Jacobi]
+
 ## 8.1.5 - 2025-05-23
 
 * Fix linting [Otavio Jacobi]

package/dist/index.d.ts

@@ -352,3 +352,30 @@ export interface UpsertParams<T extends Resource = AnyResource> extends Omit<Par
     resource: string;
     body: Partial<T['Write']>;
 }
+export type StrictODataOptions<T extends Resource['Read'] = AnyResourceObject> = Omit<ODataOptions<T>, '$select' | '$expand'> & {
+    $expand?: StrictExpand<T>;
+} & ({
+    $count: NonNullable<ODataOptions<T>['$count']>;
+    $select?: ODataOptions<T>['$select'];
+} | {
+    $count?: undefined;
+    $select: NonNullable<ODataOptions<T>['$select']>;
+});
+type StrictResourceExpand<T extends Resource['Read']> = {
+    [K in StringKeyOf<T> as ExtractExpand<T, K> extends never ? never : K]?: ExtractExpand<T, K> extends Resource['Read'] ? StrictODataOptions<ExtractExpand<T, K>> : ODataOptions<ExtractExpand<T, K>>;
+};
+type StrictExpand<T extends Resource['Read']> = StrictResourceExpand<T> | ReadonlyArray<StrictResourceExpand<T>>;
+type StrictParams<T extends Resource = AnyResource> = Omit<Params<T>, 'options'> & {
+    options: StrictODataOptions<T['Read']>;
+};
+export type StrictPinejsClientCore<Model extends {
+    [key in keyof Model]: Resource;
+} = {
+    [key in string]: AnyResource;
+}> = Omit<PinejsClientCore<Model>, 'get' | 'subscribe' | 'prepare'> & {
+    get<TResource extends StringKeyOf<Model>, TParams extends StrictParams<Model[TResource]> & {
+        resource: TResource;
+    }>(params: {
+        resource: TResource;
+    } & TParams): Promise<NoInfer<OptionsToResponse<Model[TResource]['Read'], NonNullable<StrictParams['options']>, TParams['id']>>>;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pinejs-client-core",
-  "version": "8.1.5",
+  "version": "8.1.6-build-strict-mode-ef861ef2e796bdb61ba57eaa765a41316e59bbbf-1",
   "description": "This module provides the core tools to enable easier interaction with the pinejs API.",
   "type": "commonjs",
   "browser": "dist",
@@ -52,6 +52,6 @@
     "_": "test/*.ts"
   },
   "versionist": {
-    "publishedAt": "2025-05-23T00:11:18.518Z"
+    "publishedAt": "2025-05-29T00:57:24.867Z"
   }
 }

package/src/index.ts

@@ -2039,6 +2039,7 @@ export type ResourceExpand<T extends Resource['Read'] = AnyResourceObject> = {
 export type BaseExpand<T extends Resource['Read'] = AnyResourceObject> =
 	| ExpandableStringKeyOf<T>
 	| ResourceExpand<T>;
+
 export type Expand<T extends Resource['Read'] = AnyResourceObject> =
 	| BaseExpand<T>
 	| ReadonlyArray<BaseExpand<T>>;
@@ -2163,3 +2164,65 @@ export interface UpsertParams<T extends Resource = AnyResource>
 	resource: string;
 	body: Partial<T['Write']>;
 }
+
+export type StrictODataOptions<T extends Resource['Read'] = AnyResourceObject> =
+	Omit<ODataOptions<T>, '$select' | '$expand'> & {
+		$expand?: StrictExpand<T>;
+	} & (
+			| {
+					$count: NonNullable<ODataOptions<T>['$count']>;
+					// TODO: Maybe never is the better type here?
+					// TODO: Ask Page if it makes any sense to have $count & $select together
+					$select?: ODataOptions<T>['$select'];
+			  }
+			| {
+					// TODO: Maybe never is the better type here?
+					$count?: undefined;
+					$select: NonNullable<ODataOptions<T>['$select']>;
+			  }
+		);
+
+type StrictResourceExpand<T extends Resource['Read']> = {
+	[K in StringKeyOf<T> as ExtractExpand<T, K> extends never
+		? never
+		: K]?: ExtractExpand<T, K> extends Resource['Read']
+		? StrictODataOptions<ExtractExpand<T, K>>
+		: ODataOptions<ExtractExpand<T, K>>;
+};
+
+// StrictExpand does not allow to $expand with a string or list of string (resources)
+// instead, it enforces a resource expand with $select
+type StrictExpand<T extends Resource['Read']> =
+	| StrictResourceExpand<T>
+	| ReadonlyArray<StrictResourceExpand<T>>;
+
+type StrictParams<T extends Resource = AnyResource> = Omit<
+	Params<T>,
+	'options'
+> & {
+	options: StrictODataOptions<T['Read']>;
+};
+
+// Forces a $select to exist for get, subscribe and prepare
+export type StrictPinejsClientCore<
+	Model extends { [key in keyof Model]: Resource } = {
+		[key in string]: AnyResource;
+	},
+> = Omit<PinejsClientCore<Model>, 'get' | 'subscribe' | 'prepare'> & {
+	get<
+		TResource extends StringKeyOf<Model>,
+		TParams extends StrictParams<Model[TResource]> & {
+			resource: TResource;
+		},
+	>(
+		params: { resource: TResource } & TParams,
+	): Promise<
+		NoInfer<
+			OptionsToResponse<
+				Model[TResource]['Read'],
+				NonNullable<StrictParams['options']>,
+				TParams['id']
+			>
+		>
+	>;
+};