fix: change p_type to ptype (#61)

BREAKING CHANGE: we will finally move to `ptype`, as discussed one year ago: pycasbin/sqlalchemy-adapter#26 (comment) . It is also officially documented in the official site: https://casbin.org/docs/en/adapters#:~:text=Ptype%20Column.%20Name%20of%20this%20column%20should%20be%20ptype%20instead%20of%20p_type%20or%20Ptype

Co-authored-by: Shivansh Yadav <[email protected]>

Author: hsluoyz

src/adapter.ts

@@ -26,7 +26,7 @@ export interface MongooseAdapterOptions {
 }
 
 export interface policyLine {
-  p_type?: string,
+  ptype?: string,
   v0?: string,
   v1?: string,
   v2?: string,
@@ -272,7 +272,7 @@ export class MongooseAdapter implements BatchAdapter, FilteredAdapter, Updatable
    * @param {Object} model Casbin model to which policy rule must be loaded
    */
   loadPolicyLine(line: policyLine, model: Model) {
-    let lineText = `${line.p_type!}`;
+    let lineText = `${line.ptype!}`;
 
     for (const word of [line.v0, line.v1, line.v2, line.v3, line.v4, line.v5]) {
       if (word !== undefined) {
@@ -327,12 +327,12 @@ export class MongooseAdapter implements BatchAdapter, FilteredAdapter, Updatable
    * This method is used by casbin to generate Mongoose Model Object for single policy
    * and should not be called by user.
    *
-   * @param {String} ptype Policy type to save into MongoDB
+   * @param {String} pType Policy type to save into MongoDB
    * @param {Array<String>} rule An array which consists of policy rule elements to store
    * @returns {Object} Returns a created CasbinRule record for MongoDB
    */
-  savePolicyLine(ptype: string, rule: string[]) {
-    const model = new CasbinRule({p_type: ptype});
+  savePolicyLine(pType: string, rule: string[]) {
+    const model = new CasbinRule({ptype: pType});
 
     if (rule.length > 0) {
       model.v0 = rule[0];
@@ -412,16 +412,16 @@ export class MongooseAdapter implements BatchAdapter, FilteredAdapter, Updatable
    * This method is used by casbin and should not be called by user.
    *
    * @param {String} sec Section of the policy
-   * @param {String} ptype Type of the policy (e.g. "p" or "g")
+   * @param {String} pType Type of the policy (e.g. "p" or "g")
    * @param {Array<String>} rule Policy rule to add into enforcer
    * @returns {Promise<void>}
    */
-  async addPolicy(sec: string, ptype: string, rule: string[]) {
+  async addPolicy(sec: string, pType: string, rule: string[]) {
     const options: sessionOption = {};
     try {
       if (this.isSynced) options.session = await this.getTransaction();
 
-      const line = this.savePolicyLine(ptype, rule);
+      const line = this.savePolicyLine(pType, rule);
       await line.save(options);
 
       this.autoCommit && options.session && await options.session.commitTransaction();
@@ -436,16 +436,16 @@ export class MongooseAdapter implements BatchAdapter, FilteredAdapter, Updatable
    * This method is used by casbin and should not be called by user.
    *
    * @param {String} sec Section of the policy
-   * @param {String} ptype Type of the policy (e.g. "p" or "g")
+   * @param {String} pType Type of the policy (e.g. "p" or "g")
    * @param {Array<String>} rules Policy rule to add into enforcer
    * @returns {Promise<void>}
    */
-  async addPolicies(sec: string, ptype: string, rules: Array<string[]>) {
+  async addPolicies(sec: string, pType: string, rules: Array<string[]>) {
     const options: sessionOption = {};
     if (this.isSynced) options.session = await this.getTransaction();
     else throw new InvalidAdapterTypeError('addPolicies is only supported by SyncedAdapter. See newSyncedAdapter');
     try {
-      const promises = rules.map(async rule => this.addPolicy(sec, ptype, rule));
+      const promises = rules.map(async rule => this.addPolicy(sec, pType, rule));
       await Promise.all(promises);
 
       this.autoCommit && options.session && await options.session.commitTransaction();
@@ -460,19 +460,19 @@ export class MongooseAdapter implements BatchAdapter, FilteredAdapter, Updatable
    * This method is used by casbin and should not be called by user.
    *
    * @param {String} sec Section of the policy
-   * @param {String} ptype Type of the policy (e.g. "p" or "g")
+   * @param {String} pType Type of the policy (e.g. "p" or "g")
    * @param {Array<String>} oldRule Policy rule to remove from enforcer
    * @param {Array<String>} newRule Policy rule to add into enforcer
    * @returns {Promise<void>}
    */
-  async updatePolicy(sec: string, ptype: string, oldRule: string[], newRule: string[]) {
+  async updatePolicy(sec: string, pType: string, oldRule: string[], newRule: string[]) {
     const options: sessionOption = {};
     try {
       if (this.isSynced) options.session = await this.getTransaction();
-      const {p_type, v0, v1, v2, v3, v4, v5} = this.savePolicyLine(ptype, oldRule);
-      const newRuleLine = this.savePolicyLine(ptype, newRule);
+      const {ptype, v0, v1, v2, v3, v4, v5} = this.savePolicyLine(pType, oldRule);
+      const newRuleLine = this.savePolicyLine(pType, newRule);
       const newModel = {
-        p_type: newRuleLine.p_type,
+        ptype: newRuleLine.ptype,
         v0: newRuleLine.v0,
         v1: newRuleLine.v1,
         v2: newRuleLine.v2,
@@ -481,7 +481,7 @@ export class MongooseAdapter implements BatchAdapter, FilteredAdapter, Updatable
         v5: newRuleLine.v5
       }
 
-      await CasbinRule.updateOne({p_type, v0, v1, v2, v3, v4, v5}, newModel, options);
+      await CasbinRule.updateOne({ptype, v0, v1, v2, v3, v4, v5}, newModel, options);
 
       this.autoCommit && options.session && await options.session.commitTransaction();
     } catch (err) {
@@ -495,18 +495,18 @@ export class MongooseAdapter implements BatchAdapter, FilteredAdapter, Updatable
    * This method is used by casbin and should not be called by user.
    *
    * @param {String} sec Section of the policy
-   * @param {String} ptype Type of the policy (e.g. "p" or "g")
+   * @param {String} pType Type of the policy (e.g. "p" or "g")
    * @param {Array<String>} rule Policy rule to remove from enforcer
    * @returns {Promise<void>}
    */
-  async removePolicy(sec: string, ptype: string, rule: string[]) {
+  async removePolicy(sec: string, pType: string, rule: string[]) {
     const options: sessionOption = {};
     try {
       if (this.isSynced) options.session = await this.getTransaction();
 
-      const {p_type, v0, v1, v2, v3, v4, v5} = this.savePolicyLine(ptype, rule);
+      const {ptype, v0, v1, v2, v3, v4, v5} = this.savePolicyLine(pType, rule);
 
-      await CasbinRule.deleteMany({p_type, v0, v1, v2, v3, v4, v5}, options);
+      await CasbinRule.deleteMany({ptype, v0, v1, v2, v3, v4, v5}, options);
 
       this.autoCommit && options.session && await options.session.commitTransaction();
     } catch (err) {
@@ -520,17 +520,17 @@ export class MongooseAdapter implements BatchAdapter, FilteredAdapter, Updatable
    * This method is used by casbin and should not be called by user.
    *
    * @param {String} sec Section of the policy
-   * @param {String} ptype Type of the policy (e.g. "p" or "g")
+   * @param {String} pType Type of the policy (e.g. "p" or "g")
    * @param {Array<String>} rules Policy rule to remove from enforcer
    * @returns {Promise<void>}
    */
-  async removePolicies(sec: string, ptype: string, rules: Array<string[]>) {
+  async removePolicies(sec: string, pType: string, rules: Array<string[]>) {
     const options: sessionOption = {};
     try {
       if (this.isSynced) options.session = await this.getTransaction();
       else throw new InvalidAdapterTypeError('removePolicies is only supported by SyncedAdapter. See newSyncedAdapter');
 
-      const promises = rules.map(async rule => this.removePolicy(sec, ptype, rule));
+      const promises = rules.map(async rule => this.removePolicy(sec, pType, rule));
       await Promise.all(promises);
 
       this.autoCommit && options.session && await options.session.commitTransaction();
@@ -545,16 +545,16 @@ export class MongooseAdapter implements BatchAdapter, FilteredAdapter, Updatable
    * This method is used by casbin and should not be called by user.
    *
    * @param {String} sec Section of the policy
-   * @param {String} ptype Type of the policy (e.g. "p" or "g")
+   * @param {String} pType Type of the policy (e.g. "p" or "g")
    * @param {Number} fieldIndex Index of the field to start filtering from
    * @param  {...String} fieldValues Policy rule to match when removing (starting from fieldIndex)
    * @returns {Promise<void>}
    */
-  async removeFilteredPolicy(sec: string, ptype: string, fieldIndex: number, ...fieldValues: string[]) {
+  async removeFilteredPolicy(sec: string, pType: string, fieldIndex: number, ...fieldValues: string[]) {
     const options: sessionOption = {};
     try {
       if (this.isSynced) options.session = await this.getTransaction();
-      const where: policyLine = ptype ? {p_type: ptype} : {};
+      const where: policyLine = pType ? {ptype: pType} : {};
 
       if (fieldIndex <= 0 && fieldIndex + fieldValues.length > 0 && fieldValues[0 - fieldIndex]) {
         where.v0 = fieldValues[0 - fieldIndex];

src/model.ts

@@ -15,7 +15,7 @@
 import {Schema, Document, model} from 'mongoose';
 
 export interface IModel extends Document {
-  p_type: string;
+  ptype: string;
   v0: string;
   v1: string;
   v2: string;
@@ -25,7 +25,7 @@ export interface IModel extends Document {
 }
 
 const schema = new Schema({
-  p_type: {
+  ptype: {
     type: Schema.Types.String,
     required: true,
     index: true