@apvee/spfx-react-toolkit 1.1.0 → 1.2.1

package/lib/utils/type-guards.internal.d.ts

@@ -4,31 +4,104 @@ import type { BaseListViewCommandSet, BaseFieldCustomizer } from '@microsoft/sp-
 import type { SPFxComponent, HostKind } from '../core/types';
 /**
  * Type guard: Check if instance is a WebPart
- * Uses duck typing - checks for WebPart-specific properties
+ *
+ * Uses duck typing (structural typing) to detect WebPart instances
+ * by checking for WebPart-specific properties: displayMode, domElement, render, context, properties.
+ *
+ * @template TProps - WebPart properties type
+ * @param instance - SPFx component instance to check
+ * @returns True if instance is a BaseClientSideWebPart, narrowing the type
+ *
+ * @example
+ * ```typescript
+ * if (isWebPart(instance)) {
+ *   // instance is now typed as BaseClientSideWebPart<TProps>
+ *   console.log(instance.displayMode);
+ * }
+ * ```
+ *
  * @internal
  */
 export declare function isWebPart<TProps extends {} = {}>(instance: unknown): instance is BaseClientSideWebPart<TProps>;
 /**
  * Type guard: Check if instance is an ApplicationCustomizer
- * Uses duck typing - checks for ApplicationCustomizer-specific properties
+ *
+ * Uses duck typing (structural typing) to detect ApplicationCustomizer instances
+ * by checking for placeholderProvider in context and absence of displayMode.
+ *
+ * @template TProps - ApplicationCustomizer properties type
+ * @param instance - SPFx component instance to check
+ * @returns True if instance is a BaseApplicationCustomizer, narrowing the type
+ *
+ * @example
+ * ```typescript
+ * if (isApplicationCustomizer(instance)) {
+ *   // instance is now typed as BaseApplicationCustomizer<TProps>
+ *   console.log(instance.context.placeholderProvider);
+ * }
+ * ```
+ *
  * @internal
  */
 export declare function isApplicationCustomizer<TProps extends {} = {}>(instance: unknown): instance is BaseApplicationCustomizer<TProps>;
 /**
  * Type guard: Check if instance is a ListViewCommandSet
- * Uses duck typing - checks for CommandSet-specific properties
+ *
+ * Uses duck typing (structural typing) to detect ListViewCommandSet instances
+ * by checking for onExecute and tryGetCommand methods.
+ *
+ * @template TProps - ListViewCommandSet properties type
+ * @param instance - SPFx component instance to check
+ * @returns True if instance is a BaseListViewCommandSet, narrowing the type
+ *
+ * @example
+ * ```typescript
+ * if (isListViewCommandSet(instance)) {
+ *   // instance is now typed as BaseListViewCommandSet<TProps>
+ *   instance.tryGetCommand('COMMAND_ID');
+ * }
+ * ```
+ *
  * @internal
  */
 export declare function isListViewCommandSet<TProps extends {} = {}>(instance: unknown): instance is BaseListViewCommandSet<TProps>;
 /**
  * Type guard: Check if instance is a FieldCustomizer
- * Uses duck typing - checks for FieldCustomizer-specific properties
+ *
+ * Uses duck typing (structural typing) to detect FieldCustomizer instances
+ * by checking for field in context and onRenderCell method.
+ *
+ * @template TProps - FieldCustomizer properties type
+ * @param instance - SPFx component instance to check
+ * @returns True if instance is a BaseFieldCustomizer, narrowing the type
+ *
+ * @example
+ * ```typescript
+ * if (isFieldCustomizer(instance)) {
+ *   // instance is now typed as BaseFieldCustomizer<TProps>
+ *   console.log(instance.context.field);
+ * }
+ * ```
+ *
  * @internal
  */
 export declare function isFieldCustomizer<TProps extends {} = {}>(instance: unknown): instance is BaseFieldCustomizer<TProps>;
 /**
  * Detect the kind of SPFx component from an instance
- * Throws if unable to detect
+ *
+ * Checks the instance against all known SPFx component types and returns
+ * the corresponding HostKind discriminator.
+ *
+ * @template TProps - SPFx component properties type
+ * @param instance - SPFx component instance to detect
+ * @returns HostKind ('WebPart' | 'AppCustomizer' | 'CommandSet' | 'FieldCustomizer')
+ * @throws Error if unable to detect component type
+ *
+ * @example
+ * ```typescript
+ * const kind = detectComponentKind(this); // 'WebPart'
+ * ```
+ *
  * @internal
  */
 export declare function detectComponentKind<TProps extends {} = {}>(instance: SPFxComponent<TProps>): HostKind;

package/lib/utils/type-guards.internal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"type-guards.internal.d.ts","sourceRoot":"","sources":["../../src/utils/type-guards.internal.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAChF,OAAO,KAAK,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAC;AACxG,OAAO,KAAK,EACV,aAAa,EACb,QAAQ,EACT,MAAM,eAAe,CAAC;AAEvB;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,MAAM,SAAS,EAAE,GAAG,EAAE,EAC9C,QAAQ,EAAE,OAAO,GAChB,QAAQ,IAAI,qBAAqB,CAAC,MAAM,CAAC,CAa3C;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,SAAS,EAAE,GAAG,EAAE,EAC5D,QAAQ,EAAE,OAAO,GAChB,QAAQ,IAAI,yBAAyB,CAAC,MAAM,CAAC,CAgB/C;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,SAAS,EAAE,GAAG,EAAE,EACzD,QAAQ,EAAE,OAAO,GAChB,QAAQ,IAAI,sBAAsB,CAAC,MAAM,CAAC,CAa5C;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,SAAS,EAAE,GAAG,EAAE,EACtD,QAAQ,EAAE,OAAO,GAChB,QAAQ,IAAI,mBAAmB,CAAC,MAAM,CAAC,CAiBzC;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,SAAS,EAAE,GAAG,EAAE,EACxD,QAAQ,EAAE,aAAa,CAAC,MAAM,CAAC,GAC9B,QAAQ,CAUV"}
+{"version":3,"file":"type-guards.internal.d.ts","sourceRoot":"","sources":["../../src/utils/type-guards.internal.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAChF,OAAO,KAAK,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAC;AACxG,OAAO,KAAK,EACV,aAAa,EACb,QAAQ,EACT,MAAM,eAAe,CAAC;AAEvB;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,SAAS,CAAC,MAAM,SAAS,EAAE,GAAG,EAAE,EAC9C,QAAQ,EAAE,OAAO,GAChB,QAAQ,IAAI,qBAAqB,CAAC,MAAM,CAAC,CAa3C;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,SAAS,EAAE,GAAG,EAAE,EAC5D,QAAQ,EAAE,OAAO,GAChB,QAAQ,IAAI,yBAAyB,CAAC,MAAM,CAAC,CAgB/C;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,SAAS,EAAE,GAAG,EAAE,EACzD,QAAQ,EAAE,OAAO,GAChB,QAAQ,IAAI,sBAAsB,CAAC,MAAM,CAAC,CAa5C;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,SAAS,EAAE,GAAG,EAAE,EACtD,QAAQ,EAAE,OAAO,GAChB,QAAQ,IAAI,mBAAmB,CAAC,MAAM,CAAC,CAiBzC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,SAAS,EAAE,GAAG,EAAE,EACxD,QAAQ,EAAE,aAAa,CAAC,MAAM,CAAC,GAC9B,QAAQ,CAUV"}

package/lib/utils/type-guards.internal.js

@@ -2,7 +2,22 @@
 // Type guards for SPFx component detection using structural typing (duck typing)
 /**
  * Type guard: Check if instance is a WebPart
- * Uses duck typing - checks for WebPart-specific properties
+ *
+ * Uses duck typing (structural typing) to detect WebPart instances
+ * by checking for WebPart-specific properties: displayMode, domElement, render, context, properties.
+ *
+ * @template TProps - WebPart properties type
+ * @param instance - SPFx component instance to check
+ * @returns True if instance is a BaseClientSideWebPart, narrowing the type
+ *
+ * @example
+ * ```typescript
+ * if (isWebPart(instance)) {
+ *   // instance is now typed as BaseClientSideWebPart<TProps>
+ *   console.log(instance.displayMode);
+ * }
+ * ```
+ *
  * @internal
  */
 export function isWebPart(instance) {
@@ -18,7 +33,22 @@ export function isWebPart(instance) {
 }
 /**
  * Type guard: Check if instance is an ApplicationCustomizer
- * Uses duck typing - checks for ApplicationCustomizer-specific properties
+ *
+ * Uses duck typing (structural typing) to detect ApplicationCustomizer instances
+ * by checking for placeholderProvider in context and absence of displayMode.
+ *
+ * @template TProps - ApplicationCustomizer properties type
+ * @param instance - SPFx component instance to check
+ * @returns True if instance is a BaseApplicationCustomizer, narrowing the type
+ *
+ * @example
+ * ```typescript
+ * if (isApplicationCustomizer(instance)) {
+ *   // instance is now typed as BaseApplicationCustomizer<TProps>
+ *   console.log(instance.context.placeholderProvider);
+ * }
+ * ```
+ *
  * @internal
  */
 export function isApplicationCustomizer(instance) {
@@ -36,7 +66,22 @@ export function isApplicationCustomizer(instance) {
 }
 /**
  * Type guard: Check if instance is a ListViewCommandSet
- * Uses duck typing - checks for CommandSet-specific properties
+ *
+ * Uses duck typing (structural typing) to detect ListViewCommandSet instances
+ * by checking for onExecute and tryGetCommand methods.
+ *
+ * @template TProps - ListViewCommandSet properties type
+ * @param instance - SPFx component instance to check
+ * @returns True if instance is a BaseListViewCommandSet, narrowing the type
+ *
+ * @example
+ * ```typescript
+ * if (isListViewCommandSet(instance)) {
+ *   // instance is now typed as BaseListViewCommandSet<TProps>
+ *   instance.tryGetCommand('COMMAND_ID');
+ * }
+ * ```
+ *
  * @internal
  */
 export function isListViewCommandSet(instance) {
@@ -52,7 +97,22 @@ export function isListViewCommandSet(instance) {
 }
 /**
  * Type guard: Check if instance is a FieldCustomizer
- * Uses duck typing - checks for FieldCustomizer-specific properties
+ *
+ * Uses duck typing (structural typing) to detect FieldCustomizer instances
+ * by checking for field in context and onRenderCell method.
+ *
+ * @template TProps - FieldCustomizer properties type
+ * @param instance - SPFx component instance to check
+ * @returns True if instance is a BaseFieldCustomizer, narrowing the type
+ *
+ * @example
+ * ```typescript
+ * if (isFieldCustomizer(instance)) {
+ *   // instance is now typed as BaseFieldCustomizer<TProps>
+ *   console.log(instance.context.field);
+ * }
+ * ```
+ *
  * @internal
  */
 export function isFieldCustomizer(instance) {
@@ -70,7 +130,20 @@ export function isFieldCustomizer(instance) {
 }
 /**
  * Detect the kind of SPFx component from an instance
- * Throws if unable to detect
+ *
+ * Checks the instance against all known SPFx component types and returns
+ * the corresponding HostKind discriminator.
+ *
+ * @template TProps - SPFx component properties type
+ * @param instance - SPFx component instance to detect
+ * @returns HostKind ('WebPart' | 'AppCustomizer' | 'CommandSet' | 'FieldCustomizer')
+ * @throws Error if unable to detect component type
+ *
+ * @example
+ * ```typescript
+ * const kind = detectComponentKind(this); // 'WebPart'
+ * ```
+ *
  * @internal
  */
 export function detectComponentKind(instance) {

package/lib/utils/type-guards.internal.js.map

@@ -1 +1 @@
-{"version":3,"file":"type-guards.internal.js","sourceRoot":"","sources":["../../src/utils/type-guards.internal.ts"],"names":[],"mappings":"AAAA,iBAAiB;AACjB,iFAAiF;AAUjF;;;;GAIG;AACH,MAAM,UAAU,SAAS,CACvB,QAAiB;IAEjB,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAE5D,IAAM,GAAG,GAAG,QAAmC,CAAC;IAEhD,OAAO,CACL,aAAa,IAAI,GAAG;QACpB,YAAY,IAAI,GAAG;QACnB,QAAQ,IAAI,GAAG;QACf,OAAO,GAAG,CAAC,MAAM,KAAK,UAAU;QAChC,SAAS,IAAI,GAAG;QAChB,YAAY,IAAI,GAAG,CACpB,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CACrC,QAAiB;IAEjB,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAE5D,IAAM,GAAG,GAAG,QAAmC,CAAC;IAEhD,IAAI,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,IAAI,OAAO,GAAG,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC3E,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAM,OAAO,GAAG,GAAG,CAAC,OAAkC,CAAC;IAEvD,OAAO,CACL,qBAAqB,IAAI,OAAO;QAChC,YAAY,IAAI,GAAG;QACnB,CAAC,CAAC,aAAa,IAAI,GAAG,CAAC,CAAC,gBAAgB;KACzC,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAClC,QAAiB;IAEjB,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAE5D,IAAM,GAAG,GAAG,QAAmC,CAAC;IAEhD,OAAO,CACL,WAAW,IAAI,GAAG;QAClB,OAAO,GAAG,CAAC,SAAS,KAAK,UAAU;QACnC,eAAe,IAAI,GAAG;QACtB,OAAO,GAAG,CAAC,aAAa,KAAK,UAAU;QACvC,SAAS,IAAI,GAAG;QAChB,YAAY,IAAI,GAAG,CACpB,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAC/B,QAAiB;IAEjB,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAE5D,IAAM,GAAG,GAAG,QAAmC,CAAC;IAEhD,IAAI,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,IAAI,OAAO,GAAG,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC3E,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAM,OAAO,GAAG,GAAG,CAAC,OAAkC,CAAC;IAEvD,OAAO,CACL,OAAO,IAAI,OAAO;QAClB,cAAc,IAAI,GAAG;QACrB,OAAO,GAAG,CAAC,YAAY,KAAK,UAAU;QACtC,YAAY,IAAI,GAAG,CACpB,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CACjC,QAA+B;IAE/B,IAAI,SAAS,CAAC,QAAQ,CAAC;QAAE,OAAO,SAAS,CAAC;IAC1C,IAAI,uBAAuB,CAAC,QAAQ,CAAC;QAAE,OAAO,eAAe,CAAC;IAC9D,IAAI,oBAAoB,CAAC,QAAQ,CAAC;QAAE,OAAO,YAAY,CAAC;IACxD,IAAI,iBAAiB,CAAC,QAAQ,CAAC;QAAE,OAAO,iBAAiB,CAAC;IAE1D,MAAM,IAAI,KAAK,CACb,uDAAuD;QACvD,oFAAoF,CACrF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"type-guards.internal.js","sourceRoot":"","sources":["../../src/utils/type-guards.internal.ts"],"names":[],"mappings":"AAAA,iBAAiB;AACjB,iFAAiF;AAUjF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,SAAS,CACvB,QAAiB;IAEjB,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAE5D,IAAM,GAAG,GAAG,QAAmC,CAAC;IAEhD,OAAO,CACL,aAAa,IAAI,GAAG;QACpB,YAAY,IAAI,GAAG;QACnB,QAAQ,IAAI,GAAG;QACf,OAAO,GAAG,CAAC,MAAM,KAAK,UAAU;QAChC,SAAS,IAAI,GAAG;QAChB,YAAY,IAAI,GAAG,CACpB,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,uBAAuB,CACrC,QAAiB;IAEjB,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAE5D,IAAM,GAAG,GAAG,QAAmC,CAAC;IAEhD,IAAI,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,IAAI,OAAO,GAAG,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC3E,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAM,OAAO,GAAG,GAAG,CAAC,OAAkC,CAAC;IAEvD,OAAO,CACL,qBAAqB,IAAI,OAAO;QAChC,YAAY,IAAI,GAAG;QACnB,CAAC,CAAC,aAAa,IAAI,GAAG,CAAC,CAAC,gBAAgB;KACzC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,oBAAoB,CAClC,QAAiB;IAEjB,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAE5D,IAAM,GAAG,GAAG,QAAmC,CAAC;IAEhD,OAAO,CACL,WAAW,IAAI,GAAG;QAClB,OAAO,GAAG,CAAC,SAAS,KAAK,UAAU;QACnC,eAAe,IAAI,GAAG;QACtB,OAAO,GAAG,CAAC,aAAa,KAAK,UAAU;QACvC,SAAS,IAAI,GAAG;QAChB,YAAY,IAAI,GAAG,CACpB,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,iBAAiB,CAC/B,QAAiB;IAEjB,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAE5D,IAAM,GAAG,GAAG,QAAmC,CAAC;IAEhD,IAAI,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,IAAI,OAAO,GAAG,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC3E,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAM,OAAO,GAAG,GAAG,CAAC,OAAkC,CAAC;IAEvD,OAAO,CACL,OAAO,IAAI,OAAO;QAClB,cAAc,IAAI,GAAG;QACrB,OAAO,GAAG,CAAC,YAAY,KAAK,UAAU;QACtC,YAAY,IAAI,GAAG,CACpB,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,mBAAmB,CACjC,QAA+B;IAE/B,IAAI,SAAS,CAAC,QAAQ,CAAC;QAAE,OAAO,SAAS,CAAC;IAC1C,IAAI,uBAAuB,CAAC,QAAQ,CAAC;QAAE,OAAO,eAAe,CAAC;IAC9D,IAAI,oBAAoB,CAAC,QAAQ,CAAC;QAAE,OAAO,YAAY,CAAC;IACxD,IAAI,iBAAiB,CAAC,QAAQ,CAAC;QAAE,OAAO,iBAAiB,CAAC;IAE1D,MAAM,IAAI,KAAK,CACb,uDAAuD;QACvD,oFAAoF,CACrF,CAAC;AACJ,CAAC"}

package/lib/webparts/spFxReactToolkitTest/components/SpFxReactToolkitTest.d.ts

@@ -1,8 +1,4 @@
 import * as React from 'react';
-import '@pnp/sp/webs';
-import '@pnp/sp/lists';
-import '@pnp/sp/items';
-import '@pnp/sp/site-users';
 declare const SpFxReactToolkitTest: React.FC;
 export default SpFxReactToolkitTest;
 //# sourceMappingURL=SpFxReactToolkitTest.d.ts.map

package/lib/webparts/spFxReactToolkitTest/components/SpFxReactToolkitTest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SpFxReactToolkitTest.d.ts","sourceRoot":"","sources":["../../../../src/webparts/spFxReactToolkitTest/components/SpFxReactToolkitTest.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAuD/B,OAAO,cAAc,CAAC;AACtB,OAAO,eAAe,CAAC;AACvB,OAAO,eAAe,CAAC;AACvB,OAAO,oBAAoB,CAAC;AA6+B5B,QAAA,MAAM,oBAAoB,EAAE,KAAK,CAAC,EAy/BjC,CAAC;AAEF,eAAe,oBAAoB,CAAC"}
+{"version":3,"file":"SpFxReactToolkitTest.d.ts","sourceRoot":"","sources":["../../../../src/webparts/spFxReactToolkitTest/components/SpFxReactToolkitTest.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AA0F/B,QAAA,MAAM,oBAAoB,EAAE,KAAK,CAAC,EA8/BjC,CAAC;AAEF,eAAe,oBAAoB,CAAC"}