renamed CollectionModel.schema to CollectionModel.fields

Author: ganigeorgiev

CHANGELOG.md

@@ -106,14 +106,18 @@
     ```
 
 - ⚠️ Soft-deprecated and aliased `*Url()` -> `*URL()` methods for consistency with other similar native JS APIs and the accepted Go conventions.
-    _The old methods still works but you may get a console warning to replace it because they will be removed in the future._
+    _The old methods still works but you may get a console warning to replace them because they will be removed in the future._
     ```js
     pb.baseUrl                  -> pb.baseURL
     pb.buildUrl()               -> pb.buildURL()
     pb.files.getUrl()           -> pb.files.getURL()
     pb.backups.getDownloadUrl() -> pb.backups.getDownloadURL()
     ```
 
+- ⚠️ Renamed `CollectionModel.schema` to `CollectionModel.fields`.
+
+- ⚠️ Renamed type `SchemaField` to `CollectionField`.
+
 
 ## 0.21.5
 

dist/pocketbase.cjs.d.ts

@@ -39,7 +39,7 @@ interface RecordModel extends BaseModel {
 // -------------------------------------------------------------------
 // Collection types
 // -------------------------------------------------------------------
-interface SchemaField {
+interface CollectionField {
     [key: string]: any;
     id: string;
     name: string;
@@ -94,7 +94,7 @@ interface EmailTemplate {
 }
 interface collection extends BaseModel {
     name: string;
-    schema: Array<SchemaField>;
+    fields: Array<CollectionField>;
     indexes: Array<string>;
     system: boolean;
     listRule?: string;
@@ -922,7 +922,7 @@ declare class CollectionService extends CrudService<CollectionModel> {
     /**
      * Imports the provided collections.
      *
-     * If `deleteMissing` is `true`, all local collections and schema fields,
+     * If `deleteMissing` is `true`, all local collections and their fields,
      * that are not present in the imported configuration, WILL BE DELETED
      * (including their related records data)!
      *

dist/pocketbase.cjs.js.map

@@ -60,7 +60,7 @@ interface RecordModel extends BaseModel {
 // -------------------------------------------------------------------
 // Collection types
 // -------------------------------------------------------------------
-interface SchemaField {
+interface CollectionField {
     [key: string]: any;
     id: string;
     name: string;
@@ -115,7 +115,7 @@ interface EmailTemplate {
 }
 interface collection extends BaseModel {
     name: string;
-    schema: Array<SchemaField>;
+    fields: Array<CollectionField>;
     indexes: Array<string>;
     system: boolean;
     listRule?: string;
@@ -965,7 +965,7 @@ declare class CollectionService extends CrudService<CollectionModel> {
     /**
      * Imports the provided collections.
      *
-     * If `deleteMissing` is `true`, all local collections and schema fields,
+     * If `deleteMissing` is `true`, all local collections and their fields,
      * that are not present in the imported configuration, WILL BE DELETED
      * (including their related records data)!
      *
@@ -1519,4 +1519,4 @@ declare function getTokenPayload(token: string): {
  * @param [expirationThreshold] Time in seconds that will be subtracted from the token `exp` property.
  */
 declare function isTokenExpired(token: string, expirationThreshold?: number): boolean;
-export { Client as default, BeforeSendResult, ClientResponseError, CollectionService, HealthCheckResponse, HealthService, HourlyStats, LogService, UnsubscribeFunc, RealtimeService, RecordAuthResponse, AuthProviderInfo, AuthMethodsList, RecordSubscription, OAuth2UrlCallback, OAuth2AuthConfig, OTPResponse, RecordService, CrudService, BatchRequest, BatchRequestResult, BatchService, SubBatchService, AsyncSaveFunc, AsyncClearFunc, AsyncAuthStore, AuthRecord, AuthModel, OnStoreChangeFunc, BaseAuthStore, LocalAuthStore, ListResult, BaseModel, LogModel, RecordModel, SchemaField, TokenConfig, AuthAlertConfig, OTPConfig, MFAConfig, PasswordAuthConfig, OAuth2Provider, OAuth2Config, EmailTemplate, BaseCollectionModel, ViewCollectionModel, AuthCollectionModel, CollectionModel, SendOptions, CommonOptions, ListOptions, FullListOptions, RecordOptions, RecordListOptions, RecordFullListOptions, LogStatsOptions, FileOptions, AuthOptions, normalizeUnknownQueryParams, serializeQueryParams, ParseOptions, cookieParse, SerializeOptions, cookieSerialize, getTokenPayload, isTokenExpired };
+export { Client as default, BeforeSendResult, ClientResponseError, CollectionService, HealthCheckResponse, HealthService, HourlyStats, LogService, UnsubscribeFunc, RealtimeService, RecordAuthResponse, AuthProviderInfo, AuthMethodsList, RecordSubscription, OAuth2UrlCallback, OAuth2AuthConfig, OTPResponse, RecordService, CrudService, BatchRequest, BatchRequestResult, BatchService, SubBatchService, AsyncSaveFunc, AsyncClearFunc, AsyncAuthStore, AuthRecord, AuthModel, OnStoreChangeFunc, BaseAuthStore, LocalAuthStore, ListResult, BaseModel, LogModel, RecordModel, CollectionField, TokenConfig, AuthAlertConfig, OTPConfig, MFAConfig, PasswordAuthConfig, OAuth2Provider, OAuth2Config, EmailTemplate, BaseCollectionModel, ViewCollectionModel, AuthCollectionModel, CollectionModel, SendOptions, CommonOptions, ListOptions, FullListOptions, RecordOptions, RecordListOptions, RecordFullListOptions, LogStatsOptions, FileOptions, AuthOptions, normalizeUnknownQueryParams, serializeQueryParams, ParseOptions, cookieParse, SerializeOptions, cookieSerialize, getTokenPayload, isTokenExpired };

dist/pocketbase.es.d.mts

@@ -60,7 +60,7 @@ interface RecordModel extends BaseModel {
 // -------------------------------------------------------------------
 // Collection types
 // -------------------------------------------------------------------
-interface SchemaField {
+interface CollectionField {
     [key: string]: any;
     id: string;
     name: string;
@@ -115,7 +115,7 @@ interface EmailTemplate {
 }
 interface collection extends BaseModel {
     name: string;
-    schema: Array<SchemaField>;
+    fields: Array<CollectionField>;
     indexes: Array<string>;
     system: boolean;
     listRule?: string;
@@ -965,7 +965,7 @@ declare class CollectionService extends CrudService<CollectionModel> {
     /**
      * Imports the provided collections.
      *
-     * If `deleteMissing` is `true`, all local collections and schema fields,
+     * If `deleteMissing` is `true`, all local collections and their fields,
      * that are not present in the imported configuration, WILL BE DELETED
      * (including their related records data)!
      *
@@ -1519,4 +1519,4 @@ declare function getTokenPayload(token: string): {
  * @param [expirationThreshold] Time in seconds that will be subtracted from the token `exp` property.
  */
 declare function isTokenExpired(token: string, expirationThreshold?: number): boolean;
-export { Client as default, BeforeSendResult, ClientResponseError, CollectionService, HealthCheckResponse, HealthService, HourlyStats, LogService, UnsubscribeFunc, RealtimeService, RecordAuthResponse, AuthProviderInfo, AuthMethodsList, RecordSubscription, OAuth2UrlCallback, OAuth2AuthConfig, OTPResponse, RecordService, CrudService, BatchRequest, BatchRequestResult, BatchService, SubBatchService, AsyncSaveFunc, AsyncClearFunc, AsyncAuthStore, AuthRecord, AuthModel, OnStoreChangeFunc, BaseAuthStore, LocalAuthStore, ListResult, BaseModel, LogModel, RecordModel, SchemaField, TokenConfig, AuthAlertConfig, OTPConfig, MFAConfig, PasswordAuthConfig, OAuth2Provider, OAuth2Config, EmailTemplate, BaseCollectionModel, ViewCollectionModel, AuthCollectionModel, CollectionModel, SendOptions, CommonOptions, ListOptions, FullListOptions, RecordOptions, RecordListOptions, RecordFullListOptions, LogStatsOptions, FileOptions, AuthOptions, normalizeUnknownQueryParams, serializeQueryParams, ParseOptions, cookieParse, SerializeOptions, cookieSerialize, getTokenPayload, isTokenExpired };
+export { Client as default, BeforeSendResult, ClientResponseError, CollectionService, HealthCheckResponse, HealthService, HourlyStats, LogService, UnsubscribeFunc, RealtimeService, RecordAuthResponse, AuthProviderInfo, AuthMethodsList, RecordSubscription, OAuth2UrlCallback, OAuth2AuthConfig, OTPResponse, RecordService, CrudService, BatchRequest, BatchRequestResult, BatchService, SubBatchService, AsyncSaveFunc, AsyncClearFunc, AsyncAuthStore, AuthRecord, AuthModel, OnStoreChangeFunc, BaseAuthStore, LocalAuthStore, ListResult, BaseModel, LogModel, RecordModel, CollectionField, TokenConfig, AuthAlertConfig, OTPConfig, MFAConfig, PasswordAuthConfig, OAuth2Provider, OAuth2Config, EmailTemplate, BaseCollectionModel, ViewCollectionModel, AuthCollectionModel, CollectionModel, SendOptions, CommonOptions, ListOptions, FullListOptions, RecordOptions, RecordListOptions, RecordFullListOptions, LogStatsOptions, FileOptions, AuthOptions, normalizeUnknownQueryParams, serializeQueryParams, ParseOptions, cookieParse, SerializeOptions, cookieSerialize, getTokenPayload, isTokenExpired };

dist/pocketbase.es.d.ts

@@ -39,7 +39,7 @@ interface RecordModel extends BaseModel {
 // -------------------------------------------------------------------
 // Collection types
 // -------------------------------------------------------------------
-interface SchemaField {
+interface CollectionField {
     [key: string]: any;
     id: string;
     name: string;
@@ -94,7 +94,7 @@ interface EmailTemplate {
 }
 interface collection extends BaseModel {
     name: string;
-    schema: Array<SchemaField>;
+    fields: Array<CollectionField>;
     indexes: Array<string>;
     system: boolean;
     listRule?: string;
@@ -922,7 +922,7 @@ declare class CollectionService extends CrudService<CollectionModel> {
     /**
      * Imports the provided collections.
      *
-     * If `deleteMissing` is `true`, all local collections and schema fields,
+     * If `deleteMissing` is `true`, all local collections and their fields,
      * that are not present in the imported configuration, WILL BE DELETED
      * (including their related records data)!
      *

dist/pocketbase.es.js.map

@@ -39,7 +39,7 @@ interface RecordModel extends BaseModel {
 // -------------------------------------------------------------------
 // Collection types
 // -------------------------------------------------------------------
-interface SchemaField {
+interface CollectionField {
     [key: string]: any;
     id: string;
     name: string;
@@ -94,7 +94,7 @@ interface EmailTemplate {
 }
 interface collection extends BaseModel {
     name: string;
-    schema: Array<SchemaField>;
+    fields: Array<CollectionField>;
     indexes: Array<string>;
     system: boolean;
     listRule?: string;
@@ -922,7 +922,7 @@ declare class CollectionService extends CrudService<CollectionModel> {
     /**
      * Imports the provided collections.
      *
-     * If `deleteMissing` is `true`, all local collections and schema fields,
+     * If `deleteMissing` is `true`, all local collections and their fields,
      * that are not present in the imported configuration, WILL BE DELETED
      * (including their related records data)!
      *