Merge pull request #22 from ionic-team/dev

Merge `dev` into `main` for `1.0.0` release

.github/actions/setup-tools/action.yml

@@ -8,8 +8,6 @@ runs:
       uses: actions/setup-node@v4
       with:
         node-version: 20
-        cache: 'npm'
-
     - name: Install dependencies
       shell: bash
-      run: npm install
+      run: npm i

.github/workflows/basic-tests.yml

@@ -8,18 +8,18 @@ on:
 
 jobs:
   setup:
-    uses: ./.github/workflows/reusable/setup.yml
+    uses: ./.github/workflows/reusable_setup.yml
     secrets:
       CAP_GH_RELEASE_TOKEN: ${{ secrets.CAP_GH_RELEASE_TOKEN }}
 
   lint-test:
     needs: 'setup'
-    uses: ./.github/workflows/reusable/lint.yml
+    uses: ./.github/workflows/reusable_lint.yml
     secrets:
       CAP_GH_RELEASE_TOKEN: ${{ secrets.CAP_GH_RELEASE_TOKEN }}
 
   build-packages:
     needs: 'setup'
-    uses: ./.github/workflows/reusable/build.yml
+    uses: ./.github/workflows/reusable_build.yml
     secrets:
       CAP_GH_RELEASE_TOKEN: ${{ secrets.CAP_GH_RELEASE_TOKEN }}

.github/workflows/release.yml

@@ -0,0 +1,44 @@
+name: "Release"
+
+on:
+  push:
+    branches:
+      - dev
+      - next
+      # - main
+  workflow_dispatch:
+
+jobs:
+  setup:
+    uses: ./.github/workflows/reusable_setup.yml
+    secrets:
+      THE_GH_RELEASE_TOKEN: ${{ secrets.CAP_GH_RELEASE_TOKEN }}
+
+  lint-test:
+    needs: 'setup'
+    uses: ./.github/workflows/reusable_lint.yml
+    secrets:
+      THE_GH_RELEASE_TOKEN: ${{ secrets.CAP_GH_RELEASE_TOKEN }}
+
+  build-packages:
+    needs: 'setup'
+    uses: ./.github/workflows/reusable_build.yml
+    secrets:
+      THE_GH_RELEASE_TOKEN: ${{ secrets.CAP_GH_RELEASE_TOKEN }}
+
+  release:
+    needs: ['setup','lint-test','build-packages']
+    runs-on: 'ubuntu-22.04'
+    timeout-minutes: 30
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.CAP_GH_RELEASE_TOKEN }}
+      - name: 'Setup Tools'
+        uses: ./.github/actions/setup-tools
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.CAP_GH_RELEASE_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+        run: npx semantic-release

.npmrc

@@ -0,0 +1 @@
+package-lock=false

.prettierignore

@@ -1,2 +1,3 @@
 build
 dist
+example-app

.swiftlint.yml

@@ -0,0 +1,24 @@
+excluded: 
+  - 'node_modules'
+  - 'ios/Pods' 
+  - 'example-app'
+
+opt_in_rules:
+  - 'implicitly_unwrapped_optional'
+  - 'file_name_no_space'
+  - 'force_unwrapping'
+  - 'function_default_parameter_at_end'
+  - 'lower_acl_than_parent'
+  - 'modifier_order'
+  - 'overridden_super_call'
+  - 'unowned_variable_capture'
+  - 'unused_import'
+
+line_length: 
+  warning: 250
+  error: 350
+  ignores_function_declarations: true
+  ignores_comments: true
+  ignores_interpolated_strings: true
+  ignores_urls: true
+

CHANGELOG.md

@@ -0,0 +1,101 @@
+# 1.0.0-dev.1 (2024-08-21)
+
+
+### Bug Fixes
+
+* android dep ref ([caaaf2c](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/caaaf2c61c424eaa6d82628728b2a17fa8a04133))
+* capacitor bridge ([5021349](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/50213495b200c58857d0b66ac38f6828dda91ddb))
+* ci release process ([38687ed](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/38687ed61d6ce624128c288dbc1c3ca25d2d7c7b))
+* decodeIfPresent for optional param ([29d4356](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/29d4356e813068943b8bc97cfbddbd4fb0289eef))
+* more ci fixes ([a20f93c](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/a20f93c86c24be985e7bef470c9ca0d1105ece18))
+* podspec not published ([d031b43](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/d031b435001c7420245171815e8f281467786fc3))
+* use correct parameter for openInWebView in definitions.ts ([94e36cd](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/94e36cd000d74b486d7f7c02e38edf5176b0d882))
+
+
+### Features
+
+* add documentation for isSchemeValid function ([2f39e9e](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/2f39e9eb1e4143d8ec96a8ba4075a5bab5a2100e))
+* add external browser options to sample app ([6f621f6](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/6f621f6f75c1ff304d06c6426d51e2f7e32ca7d5))
+* add webview customizations ([9ba1d27](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/9ba1d27ec6212f31f2bde39d47d14d4e5fbe6a5f))
+* **android:** implement open with external browser ([150404b](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/150404bf0c232ead5da6a37486da291343d92172))
+* check if url scheme is valid before trying to open it ([119d4d0](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/119d4d01863026e022471b89c6e42a439c453ebf))
+* implement browserPageLoaded and browserFinished events ([e70ab0c](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/e70ab0c708e770e3ca773d0a20c44f0b507d32ef))
+* implement event listeners for CustomTabs ([00071db](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/00071db7ac5d7052a61c3a11e78ab8df6bf64dbb))
+* implement openInWebView for Android ([70ad5e5](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/70ad5e50ad18a144238d5e13c4022f61ba79915d))
+* **ios:** add openInExternalBrowser ([#1](https://github.com/ionic-team/capacitor-os-inappbrowser/issues/1)) ([17a7c59](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/17a7c594c5d8fb61027a9ebe1955499a0edbf683))
+* **ios:** add openInSystemBrowser ([#3](https://github.com/ionic-team/capacitor-os-inappbrowser/issues/3)) ([fa5b065](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/fa5b0653bb38648a14165ac996852cefe99ec4ca))
+* **ios:** add openinwebview ([#5](https://github.com/ionic-team/capacitor-os-inappbrowser/issues/5)) ([1fc3485](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/1fc3485fa3571f9152040a73672d98120be4626a))
+* **ios:** close ([#8](https://github.com/ionic-team/capacitor-os-inappbrowser/issues/8)) ([075cb45](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/075cb4574d7a44cfd66ac6602193fa579f98b67f))
+* **ios:** fix error code and messages ([#18](https://github.com/ionic-team/capacitor-os-inappbrowser/issues/18)) ([2508dec](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/2508decd90dab0ebd9381992ed15295ac53669c5))
+* **ios:** webview error page ([0677a20](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/0677a20680cc49d7a19cb9212ff94cfed3c1782e))
+* swap xcframework for cocoapod + update android aar ([521ce27](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/521ce2784c0e51ba2699cb8c468f3b7677ea9393))
+* update android lib ([816866c](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/816866c489929fba83e623d57ae547a33bf6723e))
+* update capacitor bridge with new version of OSInAppBrowserLib-Android ([65a1e1a](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/65a1e1ac299e9455a685e2b83d15afbd9b3fecab))
+* update dependency to OSInAppBrowserLib-Android library ([503eb86](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/503eb86a300da008620fa93722b8524249794622))
+* update xcframework ([b4d26c8](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/b4d26c84b3697c1cbfb62809e1a8cee0c394664d))
+
+# [1.0.0-dev.6](https://github.com/ionic-team/capacitor-os-inappbrowser/compare/v1.0.0-dev.5...v1.0.0-dev.6) (2024-08-21)
+
+
+### Features
+
+* swap xcframework for cocoapod + update android aar ([ea7f639](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/ea7f639dfd745138bacc267f5e164ae2e5bbe3ba))
+
+# [1.0.0-dev.5](https://github.com/ionic-team/capacitor-os-inappbrowser/compare/v1.0.0-dev.4...v1.0.0-dev.5) (2024-08-15)
+
+
+### Bug Fixes
+
+* podspec not published ([17d1417](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/17d1417562148590ac1db4b97bfe48662f8c341e))
+
+# [1.0.0-dev.4](https://github.com/ionic-team/capacitor-os-inappbrowser/compare/v1.0.0-dev.3...v1.0.0-dev.4) (2024-08-14)
+
+
+### Bug Fixes
+
+* android dep ref ([f02d5e1](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/f02d5e14565eeed9c078e22f503776c032dd1359))
+
+# [1.0.0-dev.3](https://github.com/ionic-team/capacitor-os-inappbrowser/compare/v1.0.0-dev.2...v1.0.0-dev.3) (2024-07-25)
+
+
+### Bug Fixes
+
+* more ci fixes ([d39fb72](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/d39fb729b3a005f472cc82efc566b516881ad8de))
+
+# [1.0.0-dev.2](https://github.com/ionic-team/capacitor-os-inappbrowser/compare/v1.0.0-dev.1...v1.0.0-dev.2) (2024-07-25)
+
+
+### Bug Fixes
+
+* ci release process ([effccbd](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/effccbd917a4e8077214efdc8ccc10d23d5e519f))
+
+# 1.0.0-dev.1 (2024-07-25)
+
+
+### Bug Fixes
+
+* capacitor bridge ([5021349](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/50213495b200c58857d0b66ac38f6828dda91ddb))
+* decodeIfPresent for optional param ([29d4356](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/29d4356e813068943b8bc97cfbddbd4fb0289eef))
+* use correct parameter for openInWebView in definitions.ts ([94e36cd](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/94e36cd000d74b486d7f7c02e38edf5176b0d882))
+
+
+### Features
+
+* add documentation for isSchemeValid function ([2f39e9e](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/2f39e9eb1e4143d8ec96a8ba4075a5bab5a2100e))
+* add external browser options to sample app ([6f621f6](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/6f621f6f75c1ff304d06c6426d51e2f7e32ca7d5))
+* add webview customizations ([9ba1d27](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/9ba1d27ec6212f31f2bde39d47d14d4e5fbe6a5f))
+* **android:** implement open with external browser ([150404b](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/150404bf0c232ead5da6a37486da291343d92172))
+* check if url scheme is valid before trying to open it ([119d4d0](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/119d4d01863026e022471b89c6e42a439c453ebf))
+* implement browserPageLoaded and browserFinished events ([e70ab0c](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/e70ab0c708e770e3ca773d0a20c44f0b507d32ef))
+* implement event listeners for CustomTabs ([00071db](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/00071db7ac5d7052a61c3a11e78ab8df6bf64dbb))
+* implement openInWebView for Android ([70ad5e5](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/70ad5e50ad18a144238d5e13c4022f61ba79915d))
+* **ios:** add openInExternalBrowser ([#1](https://github.com/ionic-team/capacitor-os-inappbrowser/issues/1)) ([17a7c59](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/17a7c594c5d8fb61027a9ebe1955499a0edbf683))
+* **ios:** add openInSystemBrowser ([#3](https://github.com/ionic-team/capacitor-os-inappbrowser/issues/3)) ([fa5b065](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/fa5b0653bb38648a14165ac996852cefe99ec4ca))
+* **ios:** add openinwebview ([#5](https://github.com/ionic-team/capacitor-os-inappbrowser/issues/5)) ([1fc3485](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/1fc3485fa3571f9152040a73672d98120be4626a))
+* **ios:** close ([#8](https://github.com/ionic-team/capacitor-os-inappbrowser/issues/8)) ([075cb45](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/075cb4574d7a44cfd66ac6602193fa579f98b67f))
+* **ios:** fix error code and messages ([#18](https://github.com/ionic-team/capacitor-os-inappbrowser/issues/18)) ([2508dec](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/2508decd90dab0ebd9381992ed15295ac53669c5))
+* **ios:** webview error page ([0677a20](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/0677a20680cc49d7a19cb9212ff94cfed3c1782e))
+* update android lib ([816866c](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/816866c489929fba83e623d57ae547a33bf6723e))
+* update capacitor bridge with new version of OSInAppBrowserLib-Android ([65a1e1a](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/65a1e1ac299e9455a685e2b83d15afbd9b3fecab))
+* update dependency to OSInAppBrowserLib-Android library ([503eb86](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/503eb86a300da008620fa93722b8524249794622))
+* update xcframework ([b4d26c8](https://github.com/ionic-team/capacitor-os-inappbrowser/commit/b4d26c84b3697c1cbfb62809e1a8cee0c394664d))

CONTRIBUTING.md

@@ -41,12 +41,21 @@ Check formatting and code quality, autoformat/autofix if possible.
 
 This template is integrated with ESLint, Prettier, and SwiftLint. Using these tools is completely optional, but the [Capacitor Community](https://github.com/capacitor-community/) strives to have consistent code style and structure for easier cooperation.
 
+## Commits/PR's
+
+Commits and PR's should use the `conventional-commits` format so the release process can version and create changelog correctly.
+
+
 ## Publishing
 
-There is a `prepublishOnly` hook in `package.json` which prepares the plugin before publishing, so all you need to do is run:
+Publishing is automated based on the branch committed to. When a commit or merge is made to a branch a release that corresponds with the branch will be created:
+
+| Branch Name | Build Type | NPM Tag | Example NPM Version |
+|---|---|---|---|
+| dev | dev | dev | @capacitor/[email protected] |
+| next | next (these are betas/alphas) | next | @capacitor/[email protected] |
+| main | latest | latest | @capacitor/[email protected] |
 
-```shell
-npm publish
-```
+Dev work should be done by creating and merging PR's into the `dev` branch until a feature set is complete enough to then merge the `dev` branch into the `next` branch where it becomes a beta/alpha tagged under `next` for testing teams to use before full release. Upon completed testing the `next` branch is merged into `main` for a full release to be made. The `main` branch should then be merged into `dev` and `next` to keep them up to date with the latest code base.
 
 > **Note**: The [`files`](https://docs.npmjs.com/cli/v7/configuring-npm/package-json#files) array in `package.json` specifies which files get published. If you rename files/directories or add files elsewhere, you may need to update it.

CapacitorOsInappbrowser.podspec → CapacitorInappbrowser.podspec

@@ -3,17 +3,16 @@ require 'json'
 package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
 
 Pod::Spec.new do |s|
-  s.name = 'CapacitorOsInappbrowser'
+  s.name = 'CapacitorInappbrowser'
   s.version = package['version']
   s.summary = package['description']
   s.license = package['license']
   s.homepage = package['repository']['url']
   s.author = package['author']
   s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
-  #s.source_files = 'ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
   s.source_files = 'ios/Sources/InAppBrowserPlugin/*.{swift,h,m,c,cc,mm,cpp}'
-  s.vendored_frameworks = 'ios/Sources/InAppBrowserPlugin/OSInAppBrowserLib.xcframework' 
   s.ios.deployment_target  = '13.0'
+  s.dependency 'OSInAppBrowserLib', spec='~> 1.0'
   s.dependency 'Capacitor'
   s.swift_version = '5.1'
 end

Package.swift

@@ -2,11 +2,11 @@
 import PackageDescription
 
 let package = Package(
-    name: "CapacitorOsInappbrowser",
+    name: "CapacitorInappbrowser",
     platforms: [.iOS(.v13)],
     products: [
         .library(
-            name: "CapacitorOsInappbrowser",
+            name: "CapacitorInappbrowser",
             targets: ["InAppBrowserPlugin"])
     ],
     dependencies: [